Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-mediaservices

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AacAudioProfile

AacAudioProfile: "AacLc" | "HeAacV1" | "HeAacV2"

Defines values for AacAudioProfile. Possible values include: 'AacLc', 'HeAacV1', 'HeAacV2'

readonly
enum

{string}

AccountFiltersCreateOrUpdateResponse

AccountFiltersCreateOrUpdateResponse: AccountFilter & object

Contains response data for the createOrUpdate operation.

AccountFiltersGetResponse

AccountFiltersGetResponse: AccountFilter & object

Contains response data for the get operation.

AccountFiltersListNextResponse

AccountFiltersListNextResponse: AccountFilterCollection & object

Contains response data for the listNext operation.

AccountFiltersListResponse

AccountFiltersListResponse: AccountFilterCollection & object

Contains response data for the list operation.

AccountFiltersUpdateResponse

AccountFiltersUpdateResponse: AccountFilter & object

Contains response data for the update operation.

AnalysisResolution

AnalysisResolution: "SourceResolution" | "StandardDefinition"

Defines values for AnalysisResolution. Possible values include: 'SourceResolution', 'StandardDefinition'

readonly
enum

{string}

AssetContainerPermission

AssetContainerPermission: "Read" | "ReadWrite" | "ReadWriteDelete"

Defines values for AssetContainerPermission. Possible values include: 'Read', 'ReadWrite', 'ReadWriteDelete'

readonly
enum

{string}

AssetFiltersCreateOrUpdateResponse

AssetFiltersCreateOrUpdateResponse: AssetFilter & object

Contains response data for the createOrUpdate operation.

AssetFiltersGetResponse

AssetFiltersGetResponse: AssetFilter & object

Contains response data for the get operation.

AssetFiltersListNextResponse

AssetFiltersListNextResponse: AssetFilterCollection & object

Contains response data for the listNext operation.

AssetFiltersListResponse

AssetFiltersListResponse: AssetFilterCollection & object

Contains response data for the list operation.

AssetFiltersUpdateResponse

AssetFiltersUpdateResponse: AssetFilter & object

Contains response data for the update operation.

AssetStorageEncryptionFormat

AssetStorageEncryptionFormat: "None" | "MediaStorageClientEncryption"

Defines values for AssetStorageEncryptionFormat. Possible values include: 'None', 'MediaStorageClientEncryption'

readonly
enum

{string}

AssetsCreateOrUpdateResponse

AssetsCreateOrUpdateResponse: Asset & object

Contains response data for the createOrUpdate operation.

AssetsGetEncryptionKeyResponse

AssetsGetEncryptionKeyResponse: StorageEncryptedAssetDecryptionData & object

Contains response data for the getEncryptionKey operation.

AssetsGetResponse

AssetsGetResponse: Asset & object

Contains response data for the get operation.

AssetsListContainerSasResponse

AssetsListContainerSasResponse: AssetContainerSas & object

Contains response data for the listContainerSas operation.

AssetsListNextResponse

AssetsListNextResponse: AssetCollection & object

Contains response data for the listNext operation.

AssetsListResponse

AssetsListResponse: AssetCollection & object

Contains response data for the list operation.

AssetsListStreamingLocatorsResponse

AssetsListStreamingLocatorsResponse: ListStreamingLocatorsResponse & object

Contains response data for the listStreamingLocators operation.

AssetsUpdateResponse

AssetsUpdateResponse: Asset & object

Contains response data for the update operation.

AudioAnalyzerPresetUnion

AudioAnalyzerPresetUnion: AudioAnalyzerPreset | VideoAnalyzerPreset

Contains the possible cases for AudioAnalyzerPreset.

AudioUnion

AudioUnion: Audio | AacAudio

Contains the possible cases for Audio.

CodecUnion

Contains the possible cases for Codec.

ContentKeyPoliciesCreateOrUpdateResponse

ContentKeyPoliciesCreateOrUpdateResponse: ContentKeyPolicy & object

Contains response data for the createOrUpdate operation.

ContentKeyPoliciesGetPolicyPropertiesWithSecretsResponse

ContentKeyPoliciesGetPolicyPropertiesWithSecretsResponse: ContentKeyPolicyProperties & object

Contains response data for the getPolicyPropertiesWithSecrets operation.

ContentKeyPoliciesGetResponse

ContentKeyPoliciesGetResponse: ContentKeyPolicy & object

Contains response data for the get operation.

ContentKeyPoliciesListNextResponse

ContentKeyPoliciesListNextResponse: ContentKeyPolicyCollection & object

Contains response data for the listNext operation.

ContentKeyPoliciesListResponse

ContentKeyPoliciesListResponse: ContentKeyPolicyCollection & object

Contains response data for the list operation.

ContentKeyPoliciesUpdateResponse

ContentKeyPoliciesUpdateResponse: ContentKeyPolicy & object

Contains response data for the update operation.

ContentKeyPolicyConfigurationUnion

Contains the possible cases for ContentKeyPolicyConfiguration.

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

ContentKeyPolicyFairPlayRentalAndLeaseKeyType: "Unknown" | "Undefined" | "PersistentUnlimited" | "PersistentLimited"

Defines values for ContentKeyPolicyFairPlayRentalAndLeaseKeyType. Possible values include: 'Unknown', 'Undefined', 'PersistentUnlimited', 'PersistentLimited'

readonly
enum

{string}

ContentKeyPolicyPlayReadyContentKeyLocationUnion

Contains the possible cases for ContentKeyPolicyPlayReadyContentKeyLocation.

ContentKeyPolicyPlayReadyContentType

ContentKeyPolicyPlayReadyContentType: "Unknown" | "Unspecified" | "UltraVioletDownload" | "UltraVioletStreaming"

Defines values for ContentKeyPolicyPlayReadyContentType. Possible values include: 'Unknown', 'Unspecified', 'UltraVioletDownload', 'UltraVioletStreaming'

readonly
enum

{string}

ContentKeyPolicyPlayReadyLicenseType

ContentKeyPolicyPlayReadyLicenseType: "Unknown" | "NonPersistent" | "Persistent"

Defines values for ContentKeyPolicyPlayReadyLicenseType. Possible values include: 'Unknown', 'NonPersistent', 'Persistent'

readonly
enum

{string}

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

ContentKeyPolicyPlayReadyUnknownOutputPassingOption: "Unknown" | "NotAllowed" | "Allowed" | "AllowedWithVideoConstriction"

Defines values for ContentKeyPolicyPlayReadyUnknownOutputPassingOption. Possible values include: 'Unknown', 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction'

readonly
enum

{string}

ContentKeyPolicyRestrictionTokenKeyUnion

Contains the possible cases for ContentKeyPolicyRestrictionTokenKey.

ContentKeyPolicyRestrictionTokenType

ContentKeyPolicyRestrictionTokenType: "Unknown" | "Swt" | "Jwt"

Defines values for ContentKeyPolicyRestrictionTokenType. Possible values include: 'Unknown', 'Swt', 'Jwt'

readonly
enum

{string}

ContentKeyPolicyRestrictionUnion

Contains the possible cases for ContentKeyPolicyRestriction.

DeinterlaceMode

DeinterlaceMode: "Off" | "AutoPixelAdaptive"

Defines values for DeinterlaceMode. Possible values include: 'Off', 'AutoPixelAdaptive'

readonly
enum

{string}

DeinterlaceParity

DeinterlaceParity: "Auto" | "TopFieldFirst" | "BottomFieldFirst"

Defines values for DeinterlaceParity. Possible values include: 'Auto', 'TopFieldFirst', 'BottomFieldFirst'

readonly
enum

{string}

EncoderNamedPreset

EncoderNamedPreset: "H264SingleBitrateSD" | "H264SingleBitrate720p" | "H264SingleBitrate1080p" | "AdaptiveStreaming" | "AACGoodQualityAudio" | "ContentAwareEncodingExperimental" | "H264MultipleBitrate1080p" | "H264MultipleBitrate720p" | "H264MultipleBitrateSD"

Defines values for EncoderNamedPreset. Possible values include: 'H264SingleBitrateSD', 'H264SingleBitrate720p', 'H264SingleBitrate1080p', 'AdaptiveStreaming', 'AACGoodQualityAudio', 'ContentAwareEncodingExperimental', 'H264MultipleBitrate1080p', 'H264MultipleBitrate720p', 'H264MultipleBitrateSD'

readonly
enum

{string}

EncryptionScheme

EncryptionScheme: "NoEncryption" | "EnvelopeEncryption" | "CommonEncryptionCenc" | "CommonEncryptionCbcs"

Defines values for EncryptionScheme. Possible values include: 'NoEncryption', 'EnvelopeEncryption', 'CommonEncryptionCenc', 'CommonEncryptionCbcs'

readonly
enum

{string}

EntropyMode

EntropyMode: "Cabac" | "Cavlc"

Defines values for EntropyMode. Possible values include: 'Cabac', 'Cavlc'

readonly
enum

{string}

FilterTrackPropertyCompareOperation

FilterTrackPropertyCompareOperation: "Equal" | "NotEqual"

Defines values for FilterTrackPropertyCompareOperation. Possible values include: 'Equal', 'NotEqual'

readonly
enum

{string}

FilterTrackPropertyType

FilterTrackPropertyType: "Unknown" | "Type" | "Name" | "Language" | "FourCC" | "Bitrate"

Defines values for FilterTrackPropertyType. Possible values include: 'Unknown', 'Type', 'Name', 'Language', 'FourCC', 'Bitrate'

readonly
enum

{string}

FormatUnion

Contains the possible cases for Format.

H264Complexity

H264Complexity: "Speed" | "Balanced" | "Quality"

Defines values for H264Complexity. Possible values include: 'Speed', 'Balanced', 'Quality'

readonly
enum

{string}

H264VideoProfile

H264VideoProfile: "Auto" | "Baseline" | "Main" | "High" | "High422" | "High444"

Defines values for H264VideoProfile. Possible values include: 'Auto', 'Baseline', 'Main', 'High', 'High422', 'High444'

readonly
enum

{string}

ImageFormatUnion

ImageFormatUnion: ImageFormat | JpgFormat | PngFormat

Contains the possible cases for ImageFormat.

ImageUnion

ImageUnion: Image | JpgImage | PngImage

Contains the possible cases for Image.

InsightsType

InsightsType: "AudioInsightsOnly" | "VideoInsightsOnly" | "AllInsights"

Defines values for InsightsType. Possible values include: 'AudioInsightsOnly', 'VideoInsightsOnly', 'AllInsights'

readonly
enum

{string}

JobErrorCategory

JobErrorCategory: "Service" | "Download" | "Upload" | "Configuration" | "Content"

Defines values for JobErrorCategory. Possible values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content'

readonly
enum

{string}

JobErrorCode

JobErrorCode: "ServiceError" | "ServiceTransientError" | "DownloadNotAccessible" | "DownloadTransientError" | "UploadNotAccessible" | "UploadTransientError" | "ConfigurationUnsupported" | "ContentMalformed" | "ContentUnsupported"

Defines values for JobErrorCode. Possible values include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported'

readonly
enum

{string}

JobInputClipUnion

JobInputClipUnion: JobInputClip | JobInputAsset | JobInputHttp

Contains the possible cases for JobInputClip.

JobInputUnion

Contains the possible cases for JobInput.

JobOutputUnion

JobOutputUnion: JobOutput | JobOutputAsset

Contains the possible cases for JobOutput.

JobRetry

JobRetry: "DoNotRetry" | "MayRetry"

Defines values for JobRetry. Possible values include: 'DoNotRetry', 'MayRetry'

readonly
enum

{string}

JobState

JobState: "Canceled" | "Canceling" | "Error" | "Finished" | "Processing" | "Queued" | "Scheduled"

Defines values for JobState. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'

readonly
enum

{string}

JobsCreateResponse

JobsCreateResponse: Job & object

Contains response data for the create operation.

JobsGetResponse

JobsGetResponse: Job & object

Contains response data for the get operation.

JobsListNextResponse

JobsListNextResponse: JobCollection & object

Contains response data for the listNext operation.

JobsListResponse

JobsListResponse: JobCollection & object

Contains response data for the list operation.

JobsUpdateResponse

JobsUpdateResponse: Job & object

Contains response data for the update operation.

LayerUnion

Contains the possible cases for Layer.

LiveEventEncodingType

LiveEventEncodingType: "None" | "Basic" | "Standard"

Defines values for LiveEventEncodingType. Possible values include: 'None', 'Basic', 'Standard'

readonly
enum

{string}

LiveEventInputProtocol

LiveEventInputProtocol: "FragmentedMP4" | "RTMP"

Defines values for LiveEventInputProtocol. Possible values include: 'FragmentedMP4', 'RTMP'

readonly
enum

{string}

LiveEventResourceState

LiveEventResourceState: "Stopped" | "Starting" | "Running" | "Stopping" | "Deleting"

Defines values for LiveEventResourceState. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', 'Deleting'

readonly
enum

{string}

LiveEventsBeginCreateResponse

LiveEventsBeginCreateResponse: LiveEvent & object

Contains response data for the beginCreate operation.

LiveEventsBeginUpdateResponse

LiveEventsBeginUpdateResponse: LiveEvent & object

Contains response data for the beginUpdate operation.

LiveEventsCreateResponse

LiveEventsCreateResponse: LiveEvent & object

Contains response data for the create operation.

LiveEventsGetResponse

LiveEventsGetResponse: LiveEvent & object

Contains response data for the get operation.

LiveEventsListNextResponse

LiveEventsListNextResponse: LiveEventListResult & object

Contains response data for the listNext operation.

LiveEventsListResponse

LiveEventsListResponse: LiveEventListResult & object

Contains response data for the list operation.

LiveEventsUpdateResponse

LiveEventsUpdateResponse: LiveEvent & object

Contains response data for the update operation.

LiveOutputResourceState

LiveOutputResourceState: "Creating" | "Running" | "Deleting"

Defines values for LiveOutputResourceState. Possible values include: 'Creating', 'Running', 'Deleting'

readonly
enum

{string}

LiveOutputsBeginCreateResponse

LiveOutputsBeginCreateResponse: LiveOutput & object

Contains response data for the beginCreate operation.

LiveOutputsCreateResponse

LiveOutputsCreateResponse: LiveOutput & object

Contains response data for the create operation.

LiveOutputsGetResponse

LiveOutputsGetResponse: LiveOutput & object

Contains response data for the get operation.

LiveOutputsListNextResponse

LiveOutputsListNextResponse: LiveOutputListResult & object

Contains response data for the listNext operation.

LiveOutputsListResponse

LiveOutputsListResponse: LiveOutputListResult & object

Contains response data for the list operation.

LocationsCheckNameAvailabilityResponse

LocationsCheckNameAvailabilityResponse: EntityNameAvailabilityCheckOutput & object

Contains response data for the checkNameAvailability operation.

MediaservicesCreateOrUpdateResponse

MediaservicesCreateOrUpdateResponse: MediaService & object

Contains response data for the createOrUpdate operation.

MediaservicesGetBySubscriptionResponse

MediaservicesGetBySubscriptionResponse: SubscriptionMediaService & object

Contains response data for the getBySubscription operation.

MediaservicesGetResponse

MediaservicesGetResponse: MediaService & object

Contains response data for the get operation.

MediaservicesListBySubscriptionNextResponse

MediaservicesListBySubscriptionNextResponse: SubscriptionMediaServiceCollection & object

Contains response data for the listBySubscriptionNext operation.

MediaservicesListBySubscriptionResponse

MediaservicesListBySubscriptionResponse: SubscriptionMediaServiceCollection & object

Contains response data for the listBySubscription operation.

MediaservicesListNextResponse

MediaservicesListNextResponse: MediaServiceCollection & object

Contains response data for the listNext operation.

MediaservicesListResponse

MediaservicesListResponse: MediaServiceCollection & object

Contains response data for the list operation.

MediaservicesUpdateResponse

MediaservicesUpdateResponse: MediaService & object

Contains response data for the update operation.

MetricAggregationType

MetricAggregationType: "Average" | "Count" | "Total"

Defines values for MetricAggregationType. Possible values include: 'Average', 'Count', 'Total'

readonly
enum

{string}

MetricUnit

MetricUnit: "Bytes" | "Count" | "Milliseconds"

Defines values for MetricUnit. Possible values include: 'Bytes', 'Count', 'Milliseconds'

readonly
enum

{string}

MultiBitrateFormatUnion

Contains the possible cases for MultiBitrateFormat.

OnErrorType

OnErrorType: "StopProcessingJob" | "ContinueJob"

Defines values for OnErrorType. Possible values include: 'StopProcessingJob', 'ContinueJob'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: OperationCollection & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationCollection & object

Contains response data for the list operation.

OverlayUnion

Contains the possible cases for Overlay.

PresetUnion

Contains the possible cases for Preset.

Priority

Priority: "Low" | "Normal" | "High"

Defines values for Priority. Possible values include: 'Low', 'Normal', 'High'

readonly
enum

{string}

Rotation

Rotation: "Auto" | "None" | "Rotate0" | "Rotate90" | "Rotate180" | "Rotate270"

Defines values for Rotation. Possible values include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270'

readonly
enum

{string}

StorageAccountType

StorageAccountType: "Primary" | "Secondary"

Defines values for StorageAccountType. Possible values include: 'Primary', 'Secondary'

readonly
enum

{string}

StreamOptionsFlag

StreamOptionsFlag: "Default" | "LowLatency"

Defines values for StreamOptionsFlag. Possible values include: 'Default', 'LowLatency'

readonly
enum

{string}

StreamingEndpointResourceState

StreamingEndpointResourceState: "Stopped" | "Starting" | "Running" | "Stopping" | "Deleting" | "Scaling"

Defines values for StreamingEndpointResourceState. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', 'Deleting', 'Scaling'

readonly
enum

{string}

StreamingEndpointsBeginCreateResponse

StreamingEndpointsBeginCreateResponse: StreamingEndpoint & object

Contains response data for the beginCreate operation.

StreamingEndpointsBeginUpdateResponse

StreamingEndpointsBeginUpdateResponse: StreamingEndpoint & object

Contains response data for the beginUpdate operation.

StreamingEndpointsCreateResponse

StreamingEndpointsCreateResponse: StreamingEndpoint & object

Contains response data for the create operation.

StreamingEndpointsGetResponse

StreamingEndpointsGetResponse: StreamingEndpoint & object

Contains response data for the get operation.

StreamingEndpointsListNextResponse

StreamingEndpointsListNextResponse: StreamingEndpointListResult & object

Contains response data for the listNext operation.

StreamingEndpointsListResponse

StreamingEndpointsListResponse: StreamingEndpointListResult & object

Contains response data for the list operation.

StreamingEndpointsUpdateResponse

StreamingEndpointsUpdateResponse: StreamingEndpoint & object

Contains response data for the update operation.

StreamingLocatorContentKeyType

StreamingLocatorContentKeyType: "CommonEncryptionCenc" | "CommonEncryptionCbcs" | "EnvelopeEncryption"

Defines values for StreamingLocatorContentKeyType. Possible values include: 'CommonEncryptionCenc', 'CommonEncryptionCbcs', 'EnvelopeEncryption'

readonly
enum

{string}

StreamingLocatorsCreateResponse

StreamingLocatorsCreateResponse: StreamingLocator & object

Contains response data for the create operation.

StreamingLocatorsGetResponse

StreamingLocatorsGetResponse: StreamingLocator & object

Contains response data for the get operation.

StreamingLocatorsListContentKeysResponse

StreamingLocatorsListContentKeysResponse: ListContentKeysResponse & object

Contains response data for the listContentKeys operation.

StreamingLocatorsListNextResponse

StreamingLocatorsListNextResponse: StreamingLocatorCollection & object

Contains response data for the listNext operation.

StreamingLocatorsListPathsResponse

StreamingLocatorsListPathsResponse: ListPathsResponse & object

Contains response data for the listPaths operation.

StreamingLocatorsListResponse

StreamingLocatorsListResponse: StreamingLocatorCollection & object

Contains response data for the list operation.

StreamingPoliciesCreateResponse

StreamingPoliciesCreateResponse: StreamingPolicy & object

Contains response data for the create operation.

StreamingPoliciesGetResponse

StreamingPoliciesGetResponse: StreamingPolicy & object

Contains response data for the get operation.

StreamingPoliciesListNextResponse

StreamingPoliciesListNextResponse: StreamingPolicyCollection & object

Contains response data for the listNext operation.

StreamingPoliciesListResponse

StreamingPoliciesListResponse: StreamingPolicyCollection & object

Contains response data for the list operation.

StreamingPolicyStreamingProtocol

StreamingPolicyStreamingProtocol: "Hls" | "Dash" | "SmoothStreaming" | "Download"

Defines values for StreamingPolicyStreamingProtocol. Possible values include: 'Hls', 'Dash', 'SmoothStreaming', 'Download'

readonly
enum

{string}

StretchMode

StretchMode: "None" | "AutoSize" | "AutoFit"

Defines values for StretchMode. Possible values include: 'None', 'AutoSize', 'AutoFit'

readonly
enum

{string}

TrackPropertyCompareOperation

TrackPropertyCompareOperation: "Unknown" | "Equal"

Defines values for TrackPropertyCompareOperation. Possible values include: 'Unknown', 'Equal'

readonly
enum

{string}

TrackPropertyType

TrackPropertyType: "Unknown" | "FourCC"

Defines values for TrackPropertyType. Possible values include: 'Unknown', 'FourCC'

readonly
enum

{string}

TransformsCreateOrUpdateResponse

TransformsCreateOrUpdateResponse: Transform & object

Contains response data for the createOrUpdate operation.

TransformsGetResponse

TransformsGetResponse: Transform & object

Contains response data for the get operation.

TransformsListNextResponse

TransformsListNextResponse: TransformCollection & object

Contains response data for the listNext operation.

TransformsListResponse

TransformsListResponse: TransformCollection & object

Contains response data for the list operation.

TransformsUpdateResponse

TransformsUpdateResponse: Transform & object

Contains response data for the update operation.

VideoLayerUnion

VideoLayerUnion: VideoLayer | H264Layer

Contains the possible cases for VideoLayer.

VideoUnion

VideoUnion: Video | ImageUnion | H264Video

Contains the possible cases for Video.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AacAudio

AacAudio: object

Describes Advanced Audio Codec (AAC) audio encoding settings.

Optional bitrate

bitrate: undefined | number

The bitrate, in bits per second, of the output encoded audio.

Optional channels

channels: undefined | number

The number of channels in the audio.

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.AacAudio"

Polymorphic Discriminator

Optional profile

The encoding profile to be used when encoding audio with AAC. Possible values include: 'AacLc', 'HeAacV1', 'HeAacV2'

Optional samplingRate

samplingRate: undefined | number

The sampling rate to use for encoding in hertz.

serializedName

serializedName: string = "#Microsoft.Media.AacAudio"

type

type: object

className

className: string = "AacAudio"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

profile

profile: object

serializedName

serializedName: string = "profile"

type

type: object

name

name: "String" = "String"

Const AccountFilter

AccountFilter: object

An Account Filter.

Optional firstQuality

firstQuality: FirstQuality

The first quality.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional presentationTimeRange

presentationTimeRange: PresentationTimeRange

The presentation time range.

Optional tracks

The tracks selection conditions.

serializedName

serializedName: string = "AccountFilter"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AccountFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

firstQuality

firstQuality: object

serializedName

serializedName: string = "properties.firstQuality"

type

type: object

className

className: string = "FirstQuality"

name

name: "Composite" = "Composite"

presentationTimeRange

presentationTimeRange: object

serializedName

serializedName: string = "properties.presentationTimeRange"

type

type: object

className

className: string = "PresentationTimeRange"

name

name: "Composite" = "Composite"

tracks

tracks: object

serializedName

serializedName: string = "properties.tracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FilterTrackSelection"

name

name: "Composite" = "Composite"

Const AccountFilterCollection

AccountFilterCollection: object
interface

A collection of AccountFilter items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "AccountFilterCollection"

__@iterator

  • Iterator

    Returns IterableIterator<AccountFilter>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AccountFilter>[]

      Additional items to add to the end of array1.

    Returns AccountFilter[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AccountFilter[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AccountFilter]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AccountFilter, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AccountFilter

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AccountFilter[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AccountFilter[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AccountFilter | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AccountFilter | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AccountFilter, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AccountFilter

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AccountFilter, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AccountFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AccountFilter, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AccountFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AccountFilter | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AccountFilter

  • Parameters

    Returns AccountFilter

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AccountFilter

  • Parameters

    Returns AccountFilter

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns AccountFilter[]

shift

  • Removes the first element from an array and returns it.

    Returns AccountFilter | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AccountFilter[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AccountFilter[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AccountFilter[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AccountFilter[]

      Elements to insert into the array in place of the deleted elements.

    Returns AccountFilter[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AccountFilter[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AccountFilter>

type

type: object

className

className: string = "AccountFilterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AccountFilter"

name

name: "Composite" = "Composite"

Const AkamaiAccessControl

AkamaiAccessControl: object

Akamai access control

Optional akamaiSignatureHeaderAuthenticationKeyList

akamaiSignatureHeaderAuthenticationKeyList: AkamaiSignatureHeaderAuthenticationKey[]

authentication key list

serializedName

serializedName: string = "AkamaiAccessControl"

type

type: object

className

className: string = "AkamaiAccessControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

akamaiSignatureHeaderAuthenticationKeyList

akamaiSignatureHeaderAuthenticationKeyList: object

serializedName

serializedName: string = "akamaiSignatureHeaderAuthenticationKeyList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AkamaiSignatureHeaderAuthenticationKey"

name

name: "Composite" = "Composite"

Const AkamaiSignatureHeaderAuthenticationKey

AkamaiSignatureHeaderAuthenticationKey: object

Akamai Signature Header authentication key.

Optional base64Key

base64Key: undefined | string

authentication key

Optional expiration

expiration: Date

The expiration time of the authentication key.

Optional identifier

identifier: undefined | string

identifier of the key

serializedName

serializedName: string = "AkamaiSignatureHeaderAuthenticationKey"

type

type: object

className

className: string = "AkamaiSignatureHeaderAuthenticationKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

base64Key

base64Key: object

serializedName

serializedName: string = "base64Key"

type

type: object

name

name: "String" = "String"

expiration

expiration: object

serializedName

serializedName: string = "expiration"

type

type: object

name

name: "DateTime" = "DateTime"

identifier

identifier: object

serializedName

serializedName: string = "identifier"

type

type: object

name

name: "String" = "String"

Const ApiError

ApiError: object

The API error.

Optional error

error: ODataError

ApiError. The error properties.

serializedName

serializedName: string = "ApiError"

type

type: object

className

className: string = "ApiError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ODataError"

name

name: "Composite" = "Composite"

Const Asset

Asset: object

An Asset.

Optional alternateId

alternateId: undefined | string

The alternate ID of the Asset.

Optional assetId

assetId: undefined | string

The Asset ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional container

container: undefined | string

The name of the asset blob container.

Optional created

created: Date

The creation date of the Asset. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The Asset description.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The last modified date of the Asset. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageAccountName

storageAccountName: undefined | string

The name of the storage account.

Optional storageEncryptionFormat

storageEncryptionFormat: AssetStorageEncryptionFormat

The Asset encryption format. One of None or MediaStorageEncryption. Possible values include: 'None', 'MediaStorageClientEncryption' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Asset"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Asset"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alternateId

alternateId: object

serializedName

serializedName: string = "properties.alternateId"

type

type: object

name

name: "String" = "String"

assetId

assetId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.assetId"

type

type: object

name

name: "Uuid" = "Uuid"

container

container: object

serializedName

serializedName: string = "properties.container"

type

type: object

name

name: "String" = "String"

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

storageAccountName

storageAccountName: object

serializedName

serializedName: string = "properties.storageAccountName"

type

type: object

name

name: "String" = "String"

storageEncryptionFormat

storageEncryptionFormat: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.storageEncryptionFormat"

type

type: object

name

name: "String" = "String"

Const AssetCollection

AssetCollection: object
interface

A collection of Asset items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "AssetCollection"

__@iterator

  • __@iterator(): IterableIterator<Asset>
  • Iterator

    Returns IterableIterator<Asset>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Asset>[]): Asset[]
  • concat(...items: (T | ConcatArray<T>)[]): Asset[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Asset>[]

      Additional items to add to the end of array1.

    Returns Asset[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Asset[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Asset]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Asset]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Asset, index: number, array: Asset[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Asset, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Asset

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Asset[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Asset, index: number, array: Asset[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Asset, index: number, array: Asset[]): any
        • Parameters

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Asset[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Asset | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Asset, index: number, obj: Asset[]): boolean
        • Parameters

          • this: void
          • value: Asset
          • index: number
          • obj: Asset[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Asset, index: number, obj: Asset[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Asset | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Asset, index: number, obj: Asset[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Asset, index: number, array: Asset[]): void
        • Parameters

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Asset, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Asset

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Asset, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Asset

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Asset, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Asset

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Asset, index: number, array: Asset[]): U
        • Parameters

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Asset | undefined
  • Removes the last element from an array and returns it.

    Returns Asset | undefined

push

  • push(...items: Asset[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Asset[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Asset
  • reduce(callbackfn: function, initialValue: Asset): Asset
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Asset

  • Parameters

    • callbackfn: function
    • initialValue: Asset

    Returns Asset

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Asset, currentIndex: number, array: Asset[]): U
        • Parameters

          • previousValue: U
          • currentValue: Asset
          • currentIndex: number
          • array: Asset[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Asset
  • reduceRight(callbackfn: function, initialValue: Asset): Asset
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Asset

  • Parameters

    • callbackfn: function
    • initialValue: Asset

    Returns Asset

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Asset, currentIndex: number, array: Asset[]): U
        • Parameters

          • previousValue: U
          • currentValue: Asset
          • currentIndex: number
          • array: Asset[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Asset[]

shift

  • shift(): Asset | undefined
  • Removes the first element from an array and returns it.

    Returns Asset | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Asset[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Asset[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Asset, index: number, array: Asset[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Asset[]
  • splice(start: number, deleteCount: number, ...items: Asset[]): Asset[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Asset[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Asset[]

      Elements to insert into the array in place of the deleted elements.

    Returns Asset[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Asset[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Asset[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Asset>
  • Returns an iterable of values in the array

    Returns IterableIterator<Asset>

type

type: object

className

className: string = "AssetCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Asset"

name

name: "Composite" = "Composite"

Const AssetContainerSas

AssetContainerSas: object

The Asset Storage container SAS URLs.

Optional assetContainerSasUrls

assetContainerSasUrls: string[]

The list of Asset container SAS URLs.

serializedName

serializedName: string = "AssetContainerSas"

type

type: object

className

className: string = "AssetContainerSas"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assetContainerSasUrls

assetContainerSasUrls: object

serializedName

serializedName: string = "assetContainerSasUrls"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AssetFileEncryptionMetadata

AssetFileEncryptionMetadata: object

The Asset File Storage encryption metadata.

assetFileId

assetFileId: string

The Asset File Id.

Optional assetFileName

assetFileName: undefined | string

The Asset File name.

Optional initializationVector

initializationVector: undefined | string

The Asset File initialization vector.

serializedName

serializedName: string = "AssetFileEncryptionMetadata"

type

type: object

className

className: string = "AssetFileEncryptionMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assetFileId

assetFileId: object

required

required: true = true

serializedName

serializedName: string = "assetFileId"

type

type: object

name

name: "Uuid" = "Uuid"

assetFileName

assetFileName: object

serializedName

serializedName: string = "assetFileName"

type

type: object

name

name: "String" = "String"

initializationVector

initializationVector: object

serializedName

serializedName: string = "initializationVector"

type

type: object

name

name: "String" = "String"

Const AssetFilter

AssetFilter: object

An Asset Filter.

Optional firstQuality

firstQuality: FirstQuality

The first quality.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional presentationTimeRange

presentationTimeRange: PresentationTimeRange

The presentation time range.

Optional tracks

The tracks selection conditions.

serializedName

serializedName: string = "AssetFilter"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AssetFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

firstQuality

firstQuality: object

serializedName

serializedName: string = "properties.firstQuality"

type

type: object

className

className: string = "FirstQuality"

name

name: "Composite" = "Composite"

presentationTimeRange

presentationTimeRange: object

serializedName

serializedName: string = "properties.presentationTimeRange"

type

type: object

className

className: string = "PresentationTimeRange"

name

name: "Composite" = "Composite"

tracks

tracks: object

serializedName

serializedName: string = "properties.tracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FilterTrackSelection"

name

name: "Composite" = "Composite"

Const AssetFilterCollection

AssetFilterCollection: object
interface

A collection of AssetFilter items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "AssetFilterCollection"

__@iterator

  • Iterator

    Returns IterableIterator<AssetFilter>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AssetFilter>[]

      Additional items to add to the end of array1.

    Returns AssetFilter[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AssetFilter[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AssetFilter]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AssetFilter, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AssetFilter

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AssetFilter[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AssetFilter[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AssetFilter | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AssetFilter | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AssetFilter, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AssetFilter

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AssetFilter, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AssetFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AssetFilter, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AssetFilter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AssetFilter | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AssetFilter[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AssetFilter

  • Parameters

    Returns AssetFilter

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AssetFilter
  • reduceRight(callbackfn: function, initialValue: AssetFilter): AssetFilter
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AssetFilter

  • Parameters

    Returns AssetFilter

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns AssetFilter[]

shift

  • Removes the first element from an array and returns it.

    Returns AssetFilter | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AssetFilter[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AssetFilter[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AssetFilter[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AssetFilter[]

      Elements to insert into the array in place of the deleted elements.

    Returns AssetFilter[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AssetFilter[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AssetFilter>

type

type: object

className

className: string = "AssetFilterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AssetFilter"

name

name: "Composite" = "Composite"

Const AssetStreamingLocator

AssetStreamingLocator: object

Properties of the Streaming Locator.

Optional assetName

assetName: undefined | string

Asset Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date

The creation time of the Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultContentKeyPolicyName

defaultContentKeyPolicyName: undefined | string

Name of the default ContentKeyPolicy used by this Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

The end time of the Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Streaming Locator name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The start time of the Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional streamingLocatorId

streamingLocatorId: undefined | string

StreamingLocatorId of the Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional streamingPolicyName

streamingPolicyName: undefined | string

Name of the Streaming Policy used by this Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AssetStreamingLocator"

type

type: object

className

className: string = "AssetStreamingLocator"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assetName

assetName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "assetName"

type

type: object

name

name: "String" = "String"

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "created"

type

type: object

name

name: "DateTime" = "DateTime"

defaultContentKeyPolicyName

defaultContentKeyPolicyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "defaultContentKeyPolicyName"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

streamingLocatorId

streamingLocatorId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "streamingLocatorId"

type

type: object

name

name: "Uuid" = "Uuid"

streamingPolicyName

streamingPolicyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "streamingPolicyName"

type

type: object

name

name: "String" = "String"

Const Audio

Audio: object

Defines the common properties for all audio codecs.

Optional bitrate

bitrate: undefined | number

The bitrate, in bits per second, of the output encoded audio.

Optional channels

channels: undefined | number

The number of channels in the audio.

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.Audio"

Polymorphic Discriminator

Optional samplingRate

samplingRate: undefined | number

The sampling rate to use for encoding in hertz.

serializedName

serializedName: string = "#Microsoft.Media.Audio"

type

type: object

className

className: string = "Audio"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

bitrate

bitrate: object

serializedName

serializedName: string = "bitrate"

type

type: object

name

name: "Number" = "Number"

channels

channels: object

serializedName

serializedName: string = "channels"

type

type: object

name

name: "Number" = "Number"

samplingRate

samplingRate: object

serializedName

serializedName: string = "samplingRate"

type

type: object

name

name: "Number" = "Number"

Const AudioAnalyzerPreset

AudioAnalyzerPreset: object

The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.

Optional audioLanguage

audioLanguage: undefined | string

The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are English ('en-US' and 'en-GB'), Spanish ('es-ES' and 'es-MX'), French ('fr-FR'), Italian ('it-IT'), Japanese ('ja-JP'), Portuguese ('pt-BR'), Chinese ('zh-CN'), German ('de-DE'), Arabic ('ar-EG' and 'ar-SY'), Russian ('ru-RU'), Hindi ('hi-IN'), and Korean ('ko-KR'). If you know the language of your content, it is recommended that you specify it. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. This language detection feature currently supports English, Chinese, French, German, Italian, Japanese, Spanish, Russian, and Portuguese. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'."

odatatype

odatatype: "#Microsoft.Media.AudioAnalyzerPreset"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.AudioAnalyzerPreset"

type

type: object

className

className: string = "AudioAnalyzerPreset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Preset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

audioLanguage

audioLanguage: object

serializedName

serializedName: string = "audioLanguage"

type

type: object

name

name: "String" = "String"

Const AudioOverlay

AudioOverlay: object

Describes the properties of an audio overlay.

Optional audioGainLevel

audioGainLevel: undefined | number

The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.

Optional end

end: undefined | string

The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media.

Optional fadeInDuration

fadeInDuration: undefined | string

The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).

Optional fadeOutDuration

fadeOutDuration: undefined | string

The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).

inputLabel

inputLabel: string

The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats.

odatatype

odatatype: "#Microsoft.Media.AudioOverlay"

Polymorphic Discriminator

Optional start

start: undefined | string

The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video.

serializedName

serializedName: string = "#Microsoft.Media.AudioOverlay"

type

type: object

className

className: string = "AudioOverlay"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Overlay.type.polymorphicDiscriminator

uberParent

uberParent: string = "Overlay"

modelProperties

modelProperties: object

Const BuiltInStandardEncoderPreset

BuiltInStandardEncoderPreset: object

Describes a built-in preset for encoding the input video with the Standard Encoder.

odatatype

odatatype: "#Microsoft.Media.BuiltInStandardEncoderPreset"

Polymorphic Discriminator

presetName

presetName: EncoderNamedPreset

The built-in preset to be used for encoding videos. Possible values include: 'H264SingleBitrateSD', 'H264SingleBitrate720p', 'H264SingleBitrate1080p', 'AdaptiveStreaming', 'AACGoodQualityAudio', 'ContentAwareEncodingExperimental', 'H264MultipleBitrate1080p', 'H264MultipleBitrate720p', 'H264MultipleBitrateSD'

serializedName

serializedName: string = "#Microsoft.Media.BuiltInStandardEncoderPreset"

type

type: object

className

className: string = "BuiltInStandardEncoderPreset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Preset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

presetName

presetName: object

required

required: true = true

serializedName

serializedName: string = "presetName"

type

type: object

name

name: "String" = "String"

Const CbcsDrmConfiguration

CbcsDrmConfiguration: object

Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy

Optional fairPlay

FairPlay configurations

Optional playReady

PlayReady configurations

Optional widevine

Widevine configurations

serializedName

serializedName: string = "CbcsDrmConfiguration"

type

type: object

className

className: string = "CbcsDrmConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fairPlay

fairPlay: object

serializedName

serializedName: string = "fairPlay"

type

type: object

className

className: string = "StreamingPolicyFairPlayConfiguration"

name

name: "Composite" = "Composite"

playReady

playReady: object

serializedName

serializedName: string = "playReady"

type

type: object

className

className: string = "StreamingPolicyPlayReadyConfiguration"

name

name: "Composite" = "Composite"

widevine

widevine: object

serializedName

serializedName: string = "widevine"

type

type: object

className

className: string = "StreamingPolicyWidevineConfiguration"

name

name: "Composite" = "Composite"

Const CencDrmConfiguration

CencDrmConfiguration: object

Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy

Optional playReady

PlayReady configurations

Optional widevine

Widevine configurations

serializedName

serializedName: string = "CencDrmConfiguration"

type

type: object

className

className: string = "CencDrmConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

playReady

playReady: object

serializedName

serializedName: string = "playReady"

type

type: object

className

className: string = "StreamingPolicyPlayReadyConfiguration"

name

name: "Composite" = "Composite"

widevine

widevine: object

serializedName

serializedName: string = "widevine"

type

type: object

className

className: string = "StreamingPolicyWidevineConfiguration"

name

name: "Composite" = "Composite"

Const CheckNameAvailabilityInput

CheckNameAvailabilityInput: object

The input to the check name availability request.

Optional name

name: undefined | string

The account name.

serializedName

serializedName: string = "CheckNameAvailabilityInput"

Optional type

type: object

The account type. For a Media Services account, this should be 'MediaServices'.

className

className: string = "CheckNameAvailabilityInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const Codec

Codec: object

Describes the basic properties of all codecs.

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "Codec"

Polymorphic Discriminator

serializedName

serializedName: string = "Codec"

type

type: object

className

className: string = "Codec"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const CommonEncryptionCbcs

CommonEncryptionCbcs: object

Class for CommonEncryptionCbcs encryption scheme

Optional clearTracks

clearTracks: TrackSelection[]

Representing which tracks should not be encrypted

Optional contentKeys

Representing default content key for each encryption scheme and separate content keys for specific tracks

Optional drm

Configuration of DRMs for current encryption scheme

Optional enabledProtocols

enabledProtocols: EnabledProtocols

Representing supported protocols

serializedName

serializedName: string = "CommonEncryptionCbcs"

type

type: object

className

className: string = "CommonEncryptionCbcs"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clearTracks

clearTracks: object

serializedName

serializedName: string = "clearTracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

contentKeys

contentKeys: object

serializedName

serializedName: string = "contentKeys"

type

type: object

className

className: string = "StreamingPolicyContentKeys"

name

name: "Composite" = "Composite"

drm

drm: object

serializedName

serializedName: string = "drm"

type

type: object

className

className: string = "CbcsDrmConfiguration"

name

name: "Composite" = "Composite"

enabledProtocols

enabledProtocols: object

serializedName

serializedName: string = "enabledProtocols"

type

type: object

className

className: string = "EnabledProtocols"

name

name: "Composite" = "Composite"

Const CommonEncryptionCenc

CommonEncryptionCenc: object

Class for envelope encryption scheme

Optional clearTracks

clearTracks: TrackSelection[]

Representing which tracks should not be encrypted

Optional contentKeys

Representing default content key for each encryption scheme and separate content keys for specific tracks

Optional drm

Configuration of DRMs for CommonEncryptionCenc encryption scheme

Optional enabledProtocols

enabledProtocols: EnabledProtocols

Representing supported protocols

serializedName

serializedName: string = "CommonEncryptionCenc"

type

type: object

className

className: string = "CommonEncryptionCenc"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clearTracks

clearTracks: object

serializedName

serializedName: string = "clearTracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

contentKeys

contentKeys: object

serializedName

serializedName: string = "contentKeys"

type

type: object

className

className: string = "StreamingPolicyContentKeys"

name

name: "Composite" = "Composite"

drm

drm: object

serializedName

serializedName: string = "drm"

type

type: object

className

className: string = "CencDrmConfiguration"

name

name: "Composite" = "Composite"

enabledProtocols

enabledProtocols: object

serializedName

serializedName: string = "enabledProtocols"

type

type: object

className

className: string = "EnabledProtocols"

name

name: "Composite" = "Composite"

Const ContentKeyPolicy

ContentKeyPolicy: object

A Content Key Policy resource.

Optional created

created: Date

The creation date of the Policy NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

A description for the Policy.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The last modified date of the Policy NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

options

The Key Policy options.

Optional policyId

policyId: undefined | string

The legacy Policy ID. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContentKeyPolicy"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ContentKeyPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

options

options: object

required

required: true = true

serializedName

serializedName: string = "properties.options"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicyOption"

name

name: "Composite" = "Composite"

policyId

policyId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.policyId"

type

type: object

name

name: "Uuid" = "Uuid"

Const ContentKeyPolicyClearKeyConfiguration

ContentKeyPolicyClearKeyConfiguration: object

Represents a configuration for non-DRM keys.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyClearKeyConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

Const ContentKeyPolicyCollection

ContentKeyPolicyCollection: object
interface

A collection of ContentKeyPolicy items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "ContentKeyPolicyCollection"

__@iterator

  • Iterator

    Returns IterableIterator<ContentKeyPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ContentKeyPolicy>[]

      Additional items to add to the end of array1.

    Returns ContentKeyPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ContentKeyPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ContentKeyPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ContentKeyPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ContentKeyPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ContentKeyPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ContentKeyPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ContentKeyPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ContentKeyPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ContentKeyPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ContentKeyPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ContentKeyPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ContentKeyPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ContentKeyPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ContentKeyPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ContentKeyPolicy | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ContentKeyPolicy

  • Parameters

    Returns ContentKeyPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ContentKeyPolicy

  • Parameters

    Returns ContentKeyPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ContentKeyPolicy[]

shift

  • Removes the first element from an array and returns it.

    Returns ContentKeyPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ContentKeyPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ContentKeyPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ContentKeyPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ContentKeyPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns ContentKeyPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ContentKeyPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ContentKeyPolicy>

type

type: object

className

className: string = "ContentKeyPolicyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicy"

name

name: "Composite" = "Composite"

Const ContentKeyPolicyConfiguration

ContentKeyPolicyConfiguration: object

Base class for Content Key Policy configuration. A derived class must be used to create a configuration.

odatatype

odatatype: "ContentKeyPolicyConfiguration"

Polymorphic Discriminator

serializedName

serializedName: string = "ContentKeyPolicyConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyConfiguration"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const ContentKeyPolicyFairPlayConfiguration

ContentKeyPolicyFairPlayConfiguration: object

Specifies a configuration for FairPlay licenses.

ask

ask: Uint8Array

The key that must be used as FairPlay Application Secret key.

fairPlayPfx

fairPlayPfx: string

The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).

fairPlayPfxPassword

fairPlayPfxPassword: string

The password encrypting FairPlay certificate in PKCS 12 (pfx) format.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration"

Polymorphic Discriminator

rentalAndLeaseKeyType

The rental and lease key type. Possible values include: 'Unknown', 'Undefined', 'PersistentUnlimited', 'PersistentLimited'

rentalDuration

rentalDuration: number

The rental duration. Must be greater than or equal to 0.

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyFairPlayConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

ask

ask: object

required

required: true = true

serializedName

serializedName: string = "ask"

type

type: object

name

name: "ByteArray" = "ByteArray"

fairPlayPfx

fairPlayPfx: object

required

required: true = true

serializedName

serializedName: string = "fairPlayPfx"

type

type: object

name

name: "String" = "String"

fairPlayPfxPassword

fairPlayPfxPassword: object

required

required: true = true

serializedName

serializedName: string = "fairPlayPfxPassword"

type

type: object

name

name: "String" = "String"

rentalAndLeaseKeyType

rentalAndLeaseKeyType: object

required

required: true = true

serializedName

serializedName: string = "rentalAndLeaseKeyType"

type

type: object

name

name: "String" = "String"

rentalDuration

rentalDuration: object

required

required: true = true

serializedName

serializedName: string = "rentalDuration"

type

type: object

name

name: "Number" = "Number"

Const ContentKeyPolicyOpenRestriction

ContentKeyPolicyOpenRestriction: object

Represents an open restriction. License or key will be delivered on every request.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyOpenRestriction"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyOpenRestriction"

type

type: object

className

className: string = "ContentKeyPolicyOpenRestriction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestriction.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestriction"

modelProperties

modelProperties: object

Const ContentKeyPolicyOption

ContentKeyPolicyOption: object

Represents a policy option.

configuration

The key delivery configuration.

Optional name

name: undefined | string

The Policy Option description.

Optional policyOptionId

policyOptionId: undefined | string

The legacy Policy Option ID. NOTE: This property will not be serialized. It can only be populated by the server.

restriction

The requirements that must be met to deliver keys with this configuration

serializedName

serializedName: string = "ContentKeyPolicyOption"

type

type: object

className

className: string = "ContentKeyPolicyOption"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

configuration

configuration: object

required

required: true = true

serializedName

serializedName: string = "configuration"

type

type: object

className

className: string = "ContentKeyPolicyConfiguration"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

policyOptionId

policyOptionId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "policyOptionId"

type

type: object

name

name: "Uuid" = "Uuid"

restriction

restriction: object

required

required: true = true

serializedName

serializedName: string = "restriction"

type

type: object

className

className: string = "ContentKeyPolicyRestriction"

name

name: "Composite" = "Composite"

Const ContentKeyPolicyPlayReadyConfiguration

ContentKeyPolicyPlayReadyConfiguration: object

Specifies a configuration for PlayReady licenses.

licenses

The PlayReady licenses.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration"

Polymorphic Discriminator

Optional responseCustomData

responseCustomData: undefined | string

The custom response data.

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

licenses

licenses: object

required

required: true = true

serializedName

serializedName: string = "licenses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyLicense"

name

name: "Composite" = "Composite"

responseCustomData

responseCustomData: object

serializedName

serializedName: string = "responseCustomData"

type

type: object

name

name: "String" = "String"

Const ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader: object

Specifies that the content key ID is in the PlayReady header.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyPlayReadyContentKeyLocation.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

modelProperties

modelProperties: object

Const ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier: object

Specifies that the content key ID is specified in the PlayReady configuration.

keyId

keyId: string

The content key ID.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyPlayReadyContentKeyLocation.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

modelProperties

modelProperties: object

keyId

keyId: object

required

required: true = true

serializedName

serializedName: string = "keyId"

type

type: object

name

name: "Uuid" = "Uuid"

Const ContentKeyPolicyPlayReadyContentKeyLocation

ContentKeyPolicyPlayReadyContentKeyLocation: object

Base class for content key ID location. A derived class must be used to represent the location.

odatatype

odatatype: "ContentKeyPolicyPlayReadyContentKeyLocation"

Polymorphic Discriminator

serializedName

serializedName: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction: object

Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.

bestEffort

bestEffort: boolean

Indicates whether this restriction is enforced on a Best Effort basis.

configurationData

configurationData: number

Configures the restriction control bits. Must be between 0 and 3 inclusive.

serializedName

serializedName: string = "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bestEffort

bestEffort: object

required

required: true = true

serializedName

serializedName: string = "bestEffort"

type

type: object

name

name: "Boolean" = "Boolean"

configurationData

configurationData: object

required

required: true = true

serializedName

serializedName: string = "configurationData"

type

type: object

name

name: "Number" = "Number"

Const ContentKeyPolicyPlayReadyLicense

ContentKeyPolicyPlayReadyLicense: object

The PlayReady license

allowTestDevices

allowTestDevices: boolean

A flag indicating whether test devices can use the license.

Optional beginDate

beginDate: Date

The begin date of license

contentKeyLocation

The content key location.

contentType

The PlayReady content type. Possible values include: 'Unknown', 'Unspecified', 'UltraVioletDownload', 'UltraVioletStreaming'

Optional expirationDate

expirationDate: Date

The expiration date of license.

Optional gracePeriod

gracePeriod: undefined | string

The grace period of license.

licenseType

The license type. Possible values include: 'Unknown', 'NonPersistent', 'Persistent'

Optional playRight

The license PlayRight

Optional relativeBeginDate

relativeBeginDate: undefined | string

The relative begin date of license.

Optional relativeExpirationDate

relativeExpirationDate: undefined | string

The relative expiration date of license.

serializedName

serializedName: string = "ContentKeyPolicyPlayReadyLicense"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyLicense"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowTestDevices

allowTestDevices: object

required

required: true = true

serializedName

serializedName: string = "allowTestDevices"

type

type: object

name

name: "Boolean" = "Boolean"

beginDate

beginDate: object

serializedName

serializedName: string = "beginDate"

type

type: object

name

name: "DateTime" = "DateTime"

contentKeyLocation

contentKeyLocation: object

required

required: true = true

serializedName

serializedName: string = "contentKeyLocation"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyContentKeyLocation"

name

name: "Composite" = "Composite"

contentType

contentType: object

required

required: true = true

serializedName

serializedName: string = "contentType"

type

type: object

name

name: "String" = "String"

expirationDate

expirationDate: object

serializedName

serializedName: string = "expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

gracePeriod

gracePeriod: object

serializedName

serializedName: string = "gracePeriod"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

licenseType

licenseType: object

required

required: true = true

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

playRight

playRight: object

serializedName

serializedName: string = "playRight"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyPlayRight"

name

name: "Composite" = "Composite"

relativeBeginDate

relativeBeginDate: object

serializedName

serializedName: string = "relativeBeginDate"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

relativeExpirationDate

relativeExpirationDate: object

serializedName

serializedName: string = "relativeExpirationDate"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const ContentKeyPolicyPlayReadyPlayRight

ContentKeyPolicyPlayReadyPlayRight: object

Configures the Play Right in the PlayReady license.

Optional agcAndColorStripeRestriction

agcAndColorStripeRestriction: undefined | number

Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive.

allowPassingVideoContentToUnknownOutput

allowPassingVideoContentToUnknownOutput: ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Configures Unknown output handling settings of the license. Possible values include: 'Unknown', 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction'

Optional analogVideoOpl

analogVideoOpl: undefined | number

Specifies the output protection level for compressed digital audio.

Optional compressedDigitalAudioOpl

compressedDigitalAudioOpl: undefined | number

Specifies the output protection level for compressed digital audio.

Optional compressedDigitalVideoOpl

compressedDigitalVideoOpl: undefined | number

Specifies the output protection level for compressed digital video.

digitalVideoOnlyContentRestriction

digitalVideoOnlyContentRestriction: boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

Optional explicitAnalogTelevisionOutputRestriction

explicitAnalogTelevisionOutputRestriction: ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive.

Optional firstPlayExpiration

firstPlayExpiration: undefined | string

The amount of time that the license is valid after the license is first used to play content.

imageConstraintForAnalogComponentVideoRestriction

imageConstraintForAnalogComponentVideoRestriction: boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

imageConstraintForAnalogComputerMonitorRestriction

imageConstraintForAnalogComputerMonitorRestriction: boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

Optional scmsRestriction

scmsRestriction: undefined | number

Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive.

Optional uncompressedDigitalAudioOpl

uncompressedDigitalAudioOpl: undefined | number

Specifies the output protection level for uncompressed digital audio.

Optional uncompressedDigitalVideoOpl

uncompressedDigitalVideoOpl: undefined | number

Specifies the output protection level for uncompressed digital video.

serializedName

serializedName: string = "ContentKeyPolicyPlayReadyPlayRight"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyPlayRight"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agcAndColorStripeRestriction

agcAndColorStripeRestriction: object

serializedName

serializedName: string = "agcAndColorStripeRestriction"

type

type: object

name

name: "Number" = "Number"

allowPassingVideoContentToUnknownOutput

allowPassingVideoContentToUnknownOutput: object

required

required: true = true

serializedName

serializedName: string = "allowPassingVideoContentToUnknownOutput"

type

type: object

name

name: "String" = "String"

analogVideoOpl

analogVideoOpl: object

serializedName

serializedName: string = "analogVideoOpl"

type

type: object

name

name: "Number" = "Number"

compressedDigitalAudioOpl

compressedDigitalAudioOpl: object

serializedName

serializedName: string = "compressedDigitalAudioOpl"

type

type: object

name

name: "Number" = "Number"

compressedDigitalVideoOpl

compressedDigitalVideoOpl: object

serializedName

serializedName: string = "compressedDigitalVideoOpl"

type

type: object

name

name: "Number" = "Number"

digitalVideoOnlyContentRestriction

digitalVideoOnlyContentRestriction: object

required

required: true = true

serializedName

serializedName: string = "digitalVideoOnlyContentRestriction"

type

type: object

name

name: "Boolean" = "Boolean"

explicitAnalogTelevisionOutputRestriction

explicitAnalogTelevisionOutputRestriction: object

serializedName

serializedName: string = "explicitAnalogTelevisionOutputRestriction"

type

type: object

className

className: string = "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction"

name

name: "Composite" = "Composite"

firstPlayExpiration

firstPlayExpiration: object

serializedName

serializedName: string = "firstPlayExpiration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

imageConstraintForAnalogComponentVideoRestriction

imageConstraintForAnalogComponentVideoRestriction: object

required

required: true = true

serializedName

serializedName: string = "imageConstraintForAnalogComponentVideoRestriction"

type

type: object

name

name: "Boolean" = "Boolean"

imageConstraintForAnalogComputerMonitorRestriction

imageConstraintForAnalogComputerMonitorRestriction: object

required

required: true = true

serializedName

serializedName: string = "imageConstraintForAnalogComputerMonitorRestriction"

type

type: object

name

name: "Boolean" = "Boolean"

scmsRestriction

scmsRestriction: object

serializedName

serializedName: string = "scmsRestriction"

type

type: object

name

name: "Number" = "Number"

uncompressedDigitalAudioOpl

uncompressedDigitalAudioOpl: object

serializedName

serializedName: string = "uncompressedDigitalAudioOpl"

type

type: object

name

name: "Number" = "Number"

uncompressedDigitalVideoOpl

uncompressedDigitalVideoOpl: object

serializedName

serializedName: string = "uncompressedDigitalVideoOpl"

type

type: object

name

name: "Number" = "Number"

Const ContentKeyPolicyProperties

ContentKeyPolicyProperties: object

The properties of the Content Key Policy.

Optional created

created: Date

The creation date of the Policy NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

A description for the Policy.

Optional lastModified

lastModified: Date

The last modified date of the Policy NOTE: This property will not be serialized. It can only be populated by the server.

options

The Key Policy options.

Optional policyId

policyId: undefined | string

The legacy Policy ID. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContentKeyPolicyProperties"

type

type: object

className

className: string = "ContentKeyPolicyProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

options

options: object

required

required: true = true

serializedName

serializedName: string = "options"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicyOption"

name

name: "Composite" = "Composite"

policyId

policyId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "Uuid" = "Uuid"

Const ContentKeyPolicyRestriction

ContentKeyPolicyRestriction: object

Base class for Content Key Policy restrictions. A derived class must be used to create a restriction.

odatatype

odatatype: "ContentKeyPolicyRestriction"

Polymorphic Discriminator

serializedName

serializedName: string = "ContentKeyPolicyRestriction"

type

type: object

className

className: string = "ContentKeyPolicyRestriction"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ContentKeyPolicyRestriction"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const ContentKeyPolicyRestrictionTokenKey

ContentKeyPolicyRestrictionTokenKey: object

Base class for Content Key Policy key for token validation. A derived class must be used to create a token key.

odatatype

odatatype: "ContentKeyPolicyRestrictionTokenKey"

Polymorphic Discriminator

serializedName

serializedName: string = "ContentKeyPolicyRestrictionTokenKey"

type

type: object

className

className: string = "ContentKeyPolicyRestrictionTokenKey"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ContentKeyPolicyRestrictionTokenKey"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const ContentKeyPolicyRsaTokenKey

ContentKeyPolicyRsaTokenKey: object

Specifies a RSA key for token validation

exponent

exponent: Uint8Array

The RSA Parameter exponent

modulus

modulus: Uint8Array

The RSA Parameter modulus

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyRsaTokenKey"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyRsaTokenKey"

type

type: object

className

className: string = "ContentKeyPolicyRsaTokenKey"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestrictionTokenKey.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestrictionTokenKey"

modelProperties

modelProperties: object

exponent

exponent: object

required

required: true = true

serializedName

serializedName: string = "exponent"

type

type: object

name

name: "ByteArray" = "ByteArray"

modulus

modulus: object

required

required: true = true

serializedName

serializedName: string = "modulus"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const ContentKeyPolicySymmetricTokenKey

ContentKeyPolicySymmetricTokenKey: object

Specifies a symmetric key for token validation.

keyValue

keyValue: Uint8Array

The key value of the key

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"

type

type: object

className

className: string = "ContentKeyPolicySymmetricTokenKey"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestrictionTokenKey.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestrictionTokenKey"

modelProperties

modelProperties: object

keyValue

keyValue: object

required

required: true = true

serializedName

serializedName: string = "keyValue"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const ContentKeyPolicyTokenClaim

ContentKeyPolicyTokenClaim: object

Represents a token claim.

Optional claimType

claimType: undefined | string

Token claim type.

Optional claimValue

claimValue: undefined | string

Token claim value.

serializedName

serializedName: string = "ContentKeyPolicyTokenClaim"

type

type: object

className

className: string = "ContentKeyPolicyTokenClaim"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

claimType

claimType: object

serializedName

serializedName: string = "claimType"

type

type: object

name

name: "String" = "String"

claimValue

claimValue: object

serializedName

serializedName: string = "claimValue"

type

type: object

name

name: "String" = "String"

Const ContentKeyPolicyTokenRestriction

ContentKeyPolicyTokenRestriction: object

Represents a token restriction. Provided token must match these requirements for successful license or key delivery.

Optional alternateVerificationKeys

alternateVerificationKeys: ContentKeyPolicyRestrictionTokenKeyUnion[]

A list of alternative verification keys.

audience

audience: string

The audience for the token.

issuer

issuer: string

The token issuer.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyTokenRestriction"

Polymorphic Discriminator

Optional openIdConnectDiscoveryDocument

openIdConnectDiscoveryDocument: undefined | string

The OpenID connect discovery document.

primaryVerificationKey

The primary verification key.

Optional requiredClaims

requiredClaims: ContentKeyPolicyTokenClaim[]

A list of required token claims.

restrictionTokenType

The type of token. Possible values include: 'Unknown', 'Swt', 'Jwt'

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyTokenRestriction"

type

type: object

className

className: string = "ContentKeyPolicyTokenRestriction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestriction.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestriction"

modelProperties

modelProperties: object

alternateVerificationKeys

alternateVerificationKeys: object

serializedName

serializedName: string = "alternateVerificationKeys"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicyRestrictionTokenKey"

name

name: "Composite" = "Composite"

audience

audience: object

required

required: true = true

serializedName

serializedName: string = "audience"

type

type: object

name

name: "String" = "String"

issuer

issuer: object

required

required: true = true

serializedName

serializedName: string = "issuer"

type

type: object

name

name: "String" = "String"

openIdConnectDiscoveryDocument

openIdConnectDiscoveryDocument: object

serializedName

serializedName: string = "openIdConnectDiscoveryDocument"

type

type: object

name

name: "String" = "String"

primaryVerificationKey

primaryVerificationKey: object

required

required: true = true

serializedName

serializedName: string = "primaryVerificationKey"

type

type: object

className

className: string = "ContentKeyPolicyRestrictionTokenKey"

name

name: "Composite" = "Composite"

requiredClaims

requiredClaims: object

serializedName

serializedName: string = "requiredClaims"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContentKeyPolicyTokenClaim"

name

name: "Composite" = "Composite"

restrictionTokenType

restrictionTokenType: object

required

required: true = true

serializedName

serializedName: string = "restrictionTokenType"

type

type: object

name

name: "String" = "String"

Const ContentKeyPolicyUnknownConfiguration

ContentKeyPolicyUnknownConfiguration: object

Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyUnknownConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

Const ContentKeyPolicyUnknownRestriction

ContentKeyPolicyUnknownRestriction: object

Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyUnknownRestriction"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyUnknownRestriction"

type

type: object

className

className: string = "ContentKeyPolicyUnknownRestriction"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestriction.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestriction"

modelProperties

modelProperties: object

Const ContentKeyPolicyWidevineConfiguration

ContentKeyPolicyWidevineConfiguration: object

Specifies a configuration for Widevine licenses.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration"

Polymorphic Discriminator

widevineTemplate

widevineTemplate: string

The Widevine template.

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration"

type

type: object

className

className: string = "ContentKeyPolicyWidevineConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyConfiguration"

modelProperties

modelProperties: object

widevineTemplate

widevineTemplate: object

required

required: true = true

serializedName

serializedName: string = "widevineTemplate"

type

type: object

name

name: "String" = "String"

Const ContentKeyPolicyX509CertificateTokenKey

ContentKeyPolicyX509CertificateTokenKey: object

Specifies a certificate for token validation.

odatatype

odatatype: "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey"

Polymorphic Discriminator

rawBody

rawBody: Uint8Array

The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)

serializedName

serializedName: string = "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey"

type

type: object

className

className: string = "ContentKeyPolicyX509CertificateTokenKey"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ContentKeyPolicyRestrictionTokenKey.type.polymorphicDiscriminator

uberParent

uberParent: string = "ContentKeyPolicyRestrictionTokenKey"

modelProperties

modelProperties: object

rawBody

rawBody: object

required

required: true = true

serializedName

serializedName: string = "rawBody"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const CopyAudio

CopyAudio: object

A codec flag, which tells the encoder to copy the input audio bitstream.

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.CopyAudio"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.CopyAudio"

type

type: object

className

className: string = "CopyAudio"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

Const CopyVideo

CopyVideo: object

A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.CopyVideo"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.CopyVideo"

type

type: object

className

className: string = "CopyVideo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

Const CrossSiteAccessPolicies

CrossSiteAccessPolicies: object

The client access policy.

Optional clientAccessPolicy

clientAccessPolicy: undefined | string

The content of clientaccesspolicy.xml used by Silverlight.

Optional crossDomainPolicy

crossDomainPolicy: undefined | string

The content of crossdomain.xml used by Silverlight.

serializedName

serializedName: string = "CrossSiteAccessPolicies"

type

type: object

className

className: string = "CrossSiteAccessPolicies"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientAccessPolicy

clientAccessPolicy: object

serializedName

serializedName: string = "clientAccessPolicy"

type

type: object

name

name: "String" = "String"

crossDomainPolicy

crossDomainPolicy: object

serializedName

serializedName: string = "crossDomainPolicy"

type

type: object

name

name: "String" = "String"

Const DefaultKey

DefaultKey: object

Class to specify properties of default content key for each encryption scheme

Optional label

label: undefined | string

Label can be used to specify Content Key when creating a Streaming Locator

Optional policyName

policyName: undefined | string

Policy used by Default Key

serializedName

serializedName: string = "DefaultKey"

type

type: object

className

className: string = "DefaultKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const Deinterlace

Deinterlace: object

Describes the de-interlacing settings.

Optional mode

The deinterlacing mode. Defaults to AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive'

Optional parity

The field parity for de-interlacing, defaults to Auto. Possible values include: 'Auto', 'TopFieldFirst', 'BottomFieldFirst'

serializedName

serializedName: string = "Deinterlace"

type

type: object

className

className: string = "Deinterlace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mode

mode: object

serializedName

serializedName: string = "mode"

type

type: object

name

name: "String" = "String"

parity

parity: object

serializedName

serializedName: string = "parity"

type

type: object

name

name: "String" = "String"

Const EnabledProtocols

EnabledProtocols: object

Class to specify which protocols are enabled

dash

dash: boolean

Enable DASH protocol or not

download

download: boolean

Enable Download protocol or not

hls

hls: boolean

Enable HLS protocol or not

smoothStreaming

smoothStreaming: boolean

Enable SmoothStreaming protocol or not

serializedName

serializedName: string = "EnabledProtocols"

type

type: object

className

className: string = "EnabledProtocols"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dash

dash: object

required

required: true = true

serializedName

serializedName: string = "dash"

type

type: object

name

name: "Boolean" = "Boolean"

download

download: object

required

required: true = true

serializedName

serializedName: string = "download"

type

type: object

name

name: "Boolean" = "Boolean"

hls

hls: object

required

required: true = true

serializedName

serializedName: string = "hls"

type

type: object

name

name: "Boolean" = "Boolean"

smoothStreaming

smoothStreaming: object

required

required: true = true

serializedName

serializedName: string = "smoothStreaming"

type

type: object

name

name: "Boolean" = "Boolean"

Const EntityNameAvailabilityCheckOutput

EntityNameAvailabilityCheckOutput: object

The response from the check name availability request.

Optional message

message: undefined | string

Specifies the detailed reason if the name is not available.

nameAvailable

nameAvailable: boolean

Specifies if the name is available.

Optional reason

reason: undefined | string

Specifies the reason if the name is not available.

serializedName

serializedName: string = "EntityNameAvailabilityCheckOutput"

type

type: object

className

className: string = "EntityNameAvailabilityCheckOutput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

nameAvailable

nameAvailable: object

required

required: true = true

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

Const EnvelopeEncryption

EnvelopeEncryption: object

Class for EnvelopeEncryption encryption scheme

Optional clearTracks

clearTracks: TrackSelection[]

Representing which tracks should not be encrypted

Optional contentKeys

Representing default content key for each encryption scheme and separate content keys for specific tracks

Optional customKeyAcquisitionUrlTemplate

customKeyAcquisitionUrlTemplate: undefined | string

Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

Optional enabledProtocols

enabledProtocols: EnabledProtocols

Representing supported protocols

serializedName

serializedName: string = "EnvelopeEncryption"

type

type: object

className

className: string = "EnvelopeEncryption"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clearTracks

clearTracks: object

serializedName

serializedName: string = "clearTracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

contentKeys

contentKeys: object

serializedName

serializedName: string = "contentKeys"

type

type: object

className

className: string = "StreamingPolicyContentKeys"

name

name: "Composite" = "Composite"

customKeyAcquisitionUrlTemplate

customKeyAcquisitionUrlTemplate: object

serializedName

serializedName: string = "customKeyAcquisitionUrlTemplate"

type

type: object

name

name: "String" = "String"

enabledProtocols

enabledProtocols: object

serializedName

serializedName: string = "enabledProtocols"

type

type: object

className

className: string = "EnabledProtocols"

name

name: "Composite" = "Composite"

Const FaceDetectorPreset

FaceDetectorPreset: object

Describes all the settings to be used when analyzing a video in order to detect all the faces present.

odatatype

odatatype: "#Microsoft.Media.FaceDetectorPreset"

Polymorphic Discriminator

Optional resolution

resolution: AnalysisResolution

Specifies the maximum resolution at which your video is analyzed. The default behavior is "SourceResolution," which will keep the input video at its original resolution when analyzed. Using "StandardDefinition" will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to "StandardDefinition" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected. Possible values include: 'SourceResolution', 'StandardDefinition'

serializedName

serializedName: string = "#Microsoft.Media.FaceDetectorPreset"

type

type: object

className

className: string = "FaceDetectorPreset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Preset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

resolution

resolution: object

serializedName

serializedName: string = "resolution"

type

type: object

name

name: "String" = "String"

Const FilterTrackPropertyCondition

FilterTrackPropertyCondition: object

The class to specify one track property condition.

operation

The track property condition operation. Possible values include: 'Equal', 'NotEqual'

property

The track property type. Possible values include: 'Unknown', 'Type', 'Name', 'Language', 'FourCC', 'Bitrate'

value

value: string

The track proprty value.

serializedName

serializedName: string = "FilterTrackPropertyCondition"

type

type: object

className

className: string = "FilterTrackPropertyCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

required

required: true = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "property"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const FilterTrackSelection

FilterTrackSelection: object

Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation.

trackSelections

trackSelections: FilterTrackPropertyCondition[]

The track selections.

serializedName

serializedName: string = "FilterTrackSelection"

type

type: object

className

className: string = "FilterTrackSelection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

trackSelections

trackSelections: object

required

required: true = true

serializedName

serializedName: string = "trackSelections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FilterTrackPropertyCondition"

name

name: "Composite" = "Composite"

Const Filters

Filters: object

Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.

Optional crop

crop: Rectangle

The parameters for the rectangular window with which to crop the input video.

Optional deinterlace

deinterlace: Deinterlace

The de-interlacing settings.

Optional overlays

overlays: OverlayUnion[]

The properties of overlays to be applied to the input video. These could be audio, image or video overlays.

Optional rotation

rotation: Rotation

The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto. Possible values include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270'

serializedName

serializedName: string = "Filters"

type

type: object

className

className: string = "Filters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

crop

crop: object

serializedName

serializedName: string = "crop"

type

type: object

className

className: string = "Rectangle"

name

name: "Composite" = "Composite"

deinterlace

deinterlace: object

serializedName

serializedName: string = "deinterlace"

type

type: object

className

className: string = "Deinterlace"

name

name: "Composite" = "Composite"

overlays

overlays: object

serializedName

serializedName: string = "overlays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Overlay"

name

name: "Composite" = "Composite"

rotation

rotation: object

serializedName

serializedName: string = "rotation"

type

type: object

name

name: "String" = "String"

Const FirstQuality

FirstQuality: object

Filter First Quality

bitrate

bitrate: number

The first quality bitrate.

serializedName

serializedName: string = "FirstQuality"

type

type: object

className

className: string = "FirstQuality"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bitrate

bitrate: object

required

required: true = true

serializedName

serializedName: string = "bitrate"

type

type: object

name

name: "Number" = "Number"

Const Format

Format: object

Base class for output.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "Format"

Polymorphic Discriminator

serializedName

serializedName: string = "Format"

type

type: object

className

className: string = "Format"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

filenamePattern

filenamePattern: object

required

required: true = true

serializedName

serializedName: string = "filenamePattern"

type

type: object

name

name: "String" = "String"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const H264Layer

H264Layer: object

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

Optional adaptiveBFrame

adaptiveBFrame: undefined | false | true

Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.

Optional bFrames

bFrames: undefined | number

The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.

bitrate

bitrate: number

The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.

Optional bufferWindow

bufferWindow: undefined | string

The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S).

Optional entropyMode

entropyMode: EntropyMode

The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level. Possible values include: 'Cabac', 'Cavlc'

Optional frameRate

frameRate: undefined | string

The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.

Optional height

height: undefined | string

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

Optional label

label: undefined | string

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

Optional level

level: undefined | string

We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer.

Optional maxBitrate

maxBitrate: undefined | number

The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.

odatatype

odatatype: "#Microsoft.Media.H264Layer"

Polymorphic Discriminator

Optional profile

We currently support Baseline, Main, High, High422, High444. Default is Auto. Possible values include: 'Auto', 'Baseline', 'Main', 'High', 'High422', 'High444'

Optional referenceFrames

referenceFrames: undefined | number

The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting.

Optional slices

slices: undefined | number

The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.

Optional width

width: undefined | string

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

serializedName

serializedName: string = "#Microsoft.Media.H264Layer"

type

type: object

className

className: string = "H264Layer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Layer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Layer"

modelProperties

modelProperties: object

bufferWindow

bufferWindow: object

serializedName

serializedName: string = "bufferWindow"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

entropyMode

entropyMode: object

serializedName

serializedName: string = "entropyMode"

type

type: object

name

name: "String" = "String"

level

level: object

serializedName

serializedName: string = "level"

type

type: object

name

name: "String" = "String"

profile

profile: object

serializedName

serializedName: string = "profile"

type

type: object

name

name: "String" = "String"

referenceFrames

referenceFrames: object

serializedName

serializedName: string = "referenceFrames"

type

type: object

name

name: "Number" = "Number"

Const H264Video

H264Video: object

Describes all the properties for encoding a video with the H.264 codec.

Optional complexity

complexity: H264Complexity

Tells the encoder how to choose its encoding settings. The default value is Balanced. Possible values include: 'Speed', 'Balanced', 'Quality'

Optional keyFrameInterval

keyFrameInterval: undefined | string

The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

Optional layers

layers: H264Layer[]

The collection of output H.264 layers to be produced by the encoder.

odatatype

odatatype: "#Microsoft.Media.H264Video"

Polymorphic Discriminator

Optional sceneChangeDetection

sceneChangeDetection: undefined | false | true

Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video.

Optional stretchMode

stretchMode: StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit'

serializedName

serializedName: string = "#Microsoft.Media.H264Video"

type

type: object

className

className: string = "H264Video"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

complexity

complexity: object

serializedName

serializedName: string = "complexity"

type

type: object

name

name: "String" = "String"

layers

layers: object

serializedName

serializedName: string = "layers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "H264Layer"

name

name: "Composite" = "Composite"

sceneChangeDetection

sceneChangeDetection: object

serializedName

serializedName: string = "sceneChangeDetection"

type

type: object

name

name: "Boolean" = "Boolean"

Const Hls

Hls: object

The HLS configuration.

Optional fragmentsPerTsSegment

fragmentsPerTsSegment: undefined | number

The amount of fragments per HTTP Live Streaming (HLS) segment.

serializedName

serializedName: string = "Hls"

type

type: object

className

className: string = "Hls"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fragmentsPerTsSegment

fragmentsPerTsSegment: object

serializedName

serializedName: string = "fragmentsPerTsSegment"

type

type: object

name

name: "Number" = "Number"

Const IPAccessControl

IPAccessControl: object

The IP access control.

Optional allow

allow: IPRange[]

The IP allow list.

serializedName

serializedName: string = "IPAccessControl"

type

type: object

className

className: string = "IPAccessControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allow

allow: object

serializedName

serializedName: string = "allow"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IPRange"

name

name: "Composite" = "Composite"

Const IPRange

IPRange: object

The IP address range in the CIDR scheme.

Optional address

address: undefined | string

The IP address.

Optional name

name: undefined | string

The friendly name for the IP address range.

Optional subnetPrefixLength

subnetPrefixLength: undefined | number

The subnet mask prefix length (see CIDR notation).

serializedName

serializedName: string = "IPRange"

type

type: object

className

className: string = "IPRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "address"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

subnetPrefixLength

subnetPrefixLength: object

serializedName

serializedName: string = "subnetPrefixLength"

type

type: object

name

name: "Number" = "Number"

Const Image

Image: object

Describes the basic properties for generating thumbnails from the input video

Optional keyFrameInterval

keyFrameInterval: undefined | string

The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.Image"

Polymorphic Discriminator

Optional range

range: undefined | string

The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).

start

start: string

The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video.

Optional step

step: undefined | string

The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).

Optional stretchMode

stretchMode: StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit'

serializedName

serializedName: string = "#Microsoft.Media.Image"

type

type: object

className

className: string = "Image"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

range

range: object

serializedName

serializedName: string = "range"

type

type: object

name

name: "String" = "String"

start

start: object

required

required: true = true

serializedName

serializedName: string = "start"

type

type: object

name

name: "String" = "String"

step

step: object

serializedName

serializedName: string = "step"

type

type: object

name

name: "String" = "String"

Const ImageFormat

ImageFormat: object

Describes the properties for an output image file.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.ImageFormat"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.ImageFormat"

type

type: object

className

className: string = "ImageFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

Const Job

Job: object

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

Optional correlationData

correlationData: undefined | object

Customer provided key, value pairs that will be returned in Job and JobOutput state events.

Optional created

created: Date

The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Optional customer supplied description of the Job.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

input

The inputs for the Job.

Optional lastModified

lastModified: Date

The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

outputs

outputs: JobOutputUnion[]

The outputs for the Job.

Optional priority

priority: Priority

Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. Possible values include: 'Low', 'Normal', 'High'

Optional state

state: JobState

The current state of the job. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Job"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Job"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

correlationData

correlationData: object

serializedName

serializedName: string = "properties.correlationData"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

input

input: object

required

required: true = true

serializedName

serializedName: string = "properties.input"

type

type: object

className

className: string = "JobInput"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

outputs

outputs: object

required

required: true = true

serializedName

serializedName: string = "properties.outputs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobOutput"

name

name: "Composite" = "Composite"

priority

priority: object

serializedName

serializedName: string = "properties.priority"

type

type: object

name

name: "String" = "String"

state

state: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

Const JobCollection

JobCollection: object
interface

A collection of Job items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "JobCollection"

__@iterator

  • __@iterator(): IterableIterator<Job>
  • Iterator

    Returns IterableIterator<Job>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Job>[]): Job[]
  • concat(...items: (T | ConcatArray<T>)[]): Job[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Job>[]

      Additional items to add to the end of array1.

    Returns Job[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Job[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Job]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Job]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Job, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Job

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Job[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): any
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Job[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Job | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • this: void
          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

    Returns Job | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): void
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Job, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Job

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): U
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Job | undefined
  • Removes the last element from an array and returns it.

    Returns Job | undefined

push

  • push(...items: Job[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Job[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Job
  • reduce(callbackfn: function, initialValue: Job): Job
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Job
  • reduceRight(callbackfn: function, initialValue: Job): Job
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Job[]
  • Reverses the elements in an Array.

    Returns Job[]

shift

  • shift(): Job | undefined
  • Removes the first element from an array and returns it.

    Returns Job | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Job[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Job[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Job[]
  • splice(start: number, deleteCount: number, ...items: Job[]): Job[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Job[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Job[]

      Elements to insert into the array in place of the deleted elements.

    Returns Job[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Job[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Job[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Job>
  • Returns an iterable of values in the array

    Returns IterableIterator<Job>

type

type: object

className

className: string = "JobCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

Const JobError

JobError: object

Details of JobOutput errors.

Optional category

Helps with categorization of errors. Possible values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content' NOTE: This property will not be serialized. It can only be populated by the server.

Optional code

Error code describing the error. Possible values include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported' NOTE: This property will not be serialized. It can only be populated by the server.

Optional details

details: JobErrorDetail[]

An array of details about specific errors that led to this reported error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

A human-readable language-dependent representation of the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retry

retry: JobRetry

Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobError"

type

type: object

className

className: string = "JobError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

code

code: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobErrorDetail"

name

name: "Composite" = "Composite"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

retry

retry: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "retry"

type

type: object

name

name: "String" = "String"

Const JobErrorDetail

JobErrorDetail: object

Details of JobOutput errors.

Optional code

code: undefined | string

Code describing the error detail. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

A human-readable representation of the error. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobErrorDetail"

type

type: object

className

className: string = "JobErrorDetail"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const JobInput

JobInput: object

Base class for inputs to a Job.

odatatype

odatatype: "JobInput"

Polymorphic Discriminator

serializedName

serializedName: string = "JobInput"

type

type: object

className

className: string = "JobInput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "JobInput"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const JobInputAsset

JobInputAsset: object

Represents an Asset for input into a Job.

assetName

assetName: string

The name of the input Asset.

Optional files

files: string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

Optional label

label: undefined | string

A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.

odatatype

odatatype: "#Microsoft.Media.JobInputAsset"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.JobInputAsset"

type

type: object

className

className: string = "JobInputAsset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobInput"

modelProperties

modelProperties: object

assetName

assetName: object

required

required: true = true

serializedName

serializedName: string = "assetName"

type

type: object

name

name: "String" = "String"

Const JobInputClip

JobInputClip: object

Represents input files for a Job.

Optional files

files: string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

Optional label

label: undefined | string

A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.

odatatype

odatatype: "#Microsoft.Media.JobInputClip"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.JobInputClip"

type

type: object

className

className: string = "JobInputClip"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobInput"

modelProperties

modelProperties: object

files

files: object

serializedName

serializedName: string = "files"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

Const JobInputHttp

JobInputHttp: object

Represents HTTPS job input.

Optional baseUri

baseUri: undefined | string

Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters.

Optional files

files: string[]

List of files. Required for JobInputHttp. Maximum of 4000 characters each.

Optional label

label: undefined | string

A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.

odatatype

odatatype: "#Microsoft.Media.JobInputHttp"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.JobInputHttp"

type

type: object

className

className: string = "JobInputHttp"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobInput"

modelProperties

modelProperties: object

baseUri

baseUri: object

serializedName

serializedName: string = "baseUri"

type

type: object

name

name: "String" = "String"

Const JobInputs

JobInputs: object

Describes a list of inputs to a Job.

Optional inputs

inputs: JobInputUnion[]

List of inputs to a Job.

odatatype

odatatype: "#Microsoft.Media.JobInputs"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.JobInputs"

type

type: object

className

className: string = "JobInputs"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobInput.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobInput"

modelProperties

modelProperties: object

inputs

inputs: object

serializedName

serializedName: string = "inputs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobInput"

name

name: "Composite" = "Composite"

Const JobOutput

JobOutput: object

Describes all the properties of a JobOutput.

Optional error

error: JobError

If the JobOutput is in the Error state, it contains the details of the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional label

label: undefined | string

A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.

odatatype

odatatype: "JobOutput"

Polymorphic Discriminator

Optional progress

progress: undefined | number

If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: JobState

Describes the state of the JobOutput. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "JobOutput"

type

type: object

className

className: string = "JobOutput"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "JobOutput"

modelProperties

modelProperties: object

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "JobError"

name

name: "Composite" = "Composite"

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

progress

progress: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "progress"

type

type: object

name

name: "Number" = "Number"

state

state: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const JobOutputAsset

JobOutputAsset: object

Represents an Asset used as a JobOutput.

assetName

assetName: string

The name of the output Asset.

Optional error

error: JobError

If the JobOutput is in the Error state, it contains the details of the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional label

label: undefined | string

A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.

odatatype

odatatype: "#Microsoft.Media.JobOutputAsset"

Polymorphic Discriminator

Optional progress

progress: undefined | number

If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: JobState

Describes the state of the JobOutput. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "#Microsoft.Media.JobOutputAsset"

type

type: object

className

className: string = "JobOutputAsset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = JobOutput.type.polymorphicDiscriminator

uberParent

uberParent: string = "JobOutput"

modelProperties

modelProperties: object

assetName

assetName: object

required

required: true = true

serializedName

serializedName: string = "assetName"

type

type: object

name

name: "String" = "String"

Const JpgFormat

JpgFormat: object

Describes the settings for producing JPEG thumbnails.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.JpgFormat"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.JpgFormat"

type

type: object

className

className: string = "JpgFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

Const JpgImage

JpgImage: object

Describes the properties for producing a series of JPEG images from the input video.

Optional keyFrameInterval

keyFrameInterval: undefined | string

The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

Optional layers

layers: JpgLayer[]

A collection of output JPEG image layers to be produced by the encoder.

odatatype

odatatype: "#Microsoft.Media.JpgImage"

Polymorphic Discriminator

Optional range

range: undefined | string

The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).

start

start: string

The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video.

Optional step

step: undefined | string

The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).

Optional stretchMode

stretchMode: StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit'

serializedName

serializedName: string = "#Microsoft.Media.JpgImage"

type

type: object

className

className: string = "JpgImage"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

layers

layers: object

serializedName

serializedName: string = "layers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JpgLayer"

name

name: "Composite" = "Composite"

Const JpgLayer

JpgLayer: object

Describes the settings to produce a JPEG image from the input video.

Optional height

height: undefined | string

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

Optional label

label: undefined | string

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

odatatype

odatatype: "#Microsoft.Media.JpgLayer"

Polymorphic Discriminator

Optional quality

quality: undefined | number

The compression quality of the JPEG output. Range is from 0-100 and the default is 70.

Optional width

width: undefined | string

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

serializedName

serializedName: string = "#Microsoft.Media.JpgLayer"

type

type: object

className

className: string = "JpgLayer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Layer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Layer"

modelProperties

modelProperties: object

quality

quality: object

serializedName

serializedName: string = "quality"

type

type: object

name

name: "Number" = "Number"

Const Layer

Layer: object

The encoder can be configured to produce video and/or images (thumbnails) at different resolutions, by specifying a layer for each desired resolution. A layer represents the properties for the video or image at a resolution.

Optional height

height: undefined | string

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

Optional label

label: undefined | string

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

odatatype

odatatype: "Layer"

Polymorphic Discriminator

Optional width

width: undefined | string

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

serializedName

serializedName: string = "Layer"

type

type: object

className

className: string = "Layer"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Layer"

modelProperties

modelProperties: object

height

height: object

serializedName

serializedName: string = "height"

type

type: object

name

name: "String" = "String"

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

width

width: object

serializedName

serializedName: string = "width"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const ListContainerSasInput

ListContainerSasInput: object

The parameters to the list SAS request.

Optional expiryTime

expiryTime: Date

The SAS URL expiration time. This must be less than 24 hours from the current time.

Optional permissions

The permissions to set on the SAS URL. Possible values include: 'Read', 'ReadWrite', 'ReadWriteDelete'

serializedName

serializedName: string = "ListContainerSasInput"

type

type: object

className

className: string = "ListContainerSasInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTime

expiryTime: object

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

permissions

permissions: object

serializedName

serializedName: string = "permissions"

type

type: object

name

name: "String" = "String"

Const ListContentKeysResponse

ListContentKeysResponse: object

Class of response for listContentKeys action

Optional contentKeys

ContentKeys used by current Streaming Locator

serializedName

serializedName: string = "ListContentKeysResponse"

type

type: object

className

className: string = "ListContentKeysResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentKeys

contentKeys: object

serializedName

serializedName: string = "contentKeys"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingLocatorContentKey"

name

name: "Composite" = "Composite"

Const ListPathsResponse

ListPathsResponse: object

Class of response for listPaths action

Optional downloadPaths

downloadPaths: string[]

Download Paths supported by current Streaming Locator

Optional streamingPaths

streamingPaths: StreamingPath[]

Streaming Paths supported by current Streaming Locator

serializedName

serializedName: string = "ListPathsResponse"

type

type: object

className

className: string = "ListPathsResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

downloadPaths

downloadPaths: object

serializedName

serializedName: string = "downloadPaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

streamingPaths

streamingPaths: object

serializedName

serializedName: string = "streamingPaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingPath"

name

name: "Composite" = "Composite"

Const ListStreamingLocatorsResponse

ListStreamingLocatorsResponse: object

The Streaming Locators associated with this Asset.

Optional streamingLocators

streamingLocators: AssetStreamingLocator[]

The list of Streaming Locators. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ListStreamingLocatorsResponse"

type

type: object

className

className: string = "ListStreamingLocatorsResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

streamingLocators

streamingLocators: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "streamingLocators"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AssetStreamingLocator"

name

name: "Composite" = "Composite"

Const LiveEvent

LiveEvent: object

The Live Event.

Optional created

created: Date

The exact time the Live Event was created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional crossSiteAccessPolicies

crossSiteAccessPolicies: CrossSiteAccessPolicies

The Live Event access policies.

Optional description

description: undefined | string

The Live Event description.

Optional encoding

The Live Event encoding.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

input

The Live Event input.

Optional lastModified

lastModified: Date

The exact time the Live Event was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The Azure Region of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional preview

The Live Event preview.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the Live Event. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceState

resourceState: LiveEventResourceState

The resource state of the Live Event. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional streamOptions

streamOptions: StreamOptionsFlag[]

The options to use for the LiveEvent. This value is specified at creation time and cannot be updated.

Optional tags

tags: undefined | object

Resource tags.

Optional vanityUrl

vanityUrl: undefined | false | true

Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated.

serializedName

serializedName: string = "LiveEvent"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LiveEvent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

crossSiteAccessPolicies

crossSiteAccessPolicies: object

serializedName

serializedName: string = "properties.crossSiteAccessPolicies"

type

type: object

className

className: string = "CrossSiteAccessPolicies"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

encoding

encoding: object

serializedName

serializedName: string = "properties.encoding"

type

type: object

className

className: string = "LiveEventEncoding"

name

name: "Composite" = "Composite"

input

input: object

required

required: true = true

serializedName

serializedName: string = "properties.input"

type

type: object

className

className: string = "LiveEventInput"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

preview

preview: object

serializedName

serializedName: string = "properties.preview"

type

type: object

className

className: string = "LiveEventPreview"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceState

resourceState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceState"

type

type: object

allowedValues

allowedValues: string[] = ["Stopped","Starting","Running","Stopping","Deleting"]

name

name: "Enum" = "Enum"

streamOptions

streamOptions: object

serializedName

serializedName: string = "properties.streamOptions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Default","LowLatency"]

name

name: "Enum" = "Enum"

vanityUrl

vanityUrl: object

serializedName

serializedName: string = "properties.vanityUrl"

type

type: object

name

name: "Boolean" = "Boolean"

Const LiveEventActionInput

LiveEventActionInput: object

The LiveEvent action input parameter definition.

Optional removeOutputsOnStop

removeOutputsOnStop: undefined | false | true

The flag indicates if remove LiveOutputs on Stop.

serializedName

serializedName: string = "LiveEventActionInput"

type

type: object

className

className: string = "LiveEventActionInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

removeOutputsOnStop

removeOutputsOnStop: object

serializedName

serializedName: string = "removeOutputsOnStop"

type

type: object

name

name: "Boolean" = "Boolean"

Const LiveEventEncoding

LiveEventEncoding: object

The Live Event encoding.

Optional encodingType

encodingType: LiveEventEncodingType

The encoding type for Live Event. This value is specified at creation time and cannot be updated. Possible values include: 'None', 'Basic', 'Standard'

Optional presetName

presetName: undefined | string

The encoding preset name. This value is specified at creation time and cannot be updated.

serializedName

serializedName: string = "LiveEventEncoding"

type

type: object

className

className: string = "LiveEventEncoding"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encodingType

encodingType: object

serializedName

serializedName: string = "encodingType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Basic","Standard"]

name

name: "Enum" = "Enum"

presetName

presetName: object

serializedName

serializedName: string = "presetName"

type

type: object

name

name: "String" = "String"

Const LiveEventEndpoint

LiveEventEndpoint: object

The Live Event endpoint.

Optional protocol

protocol: undefined | string

The endpoint protocol.

Optional url

url: undefined | string

The endpoint URL.

serializedName

serializedName: string = "LiveEventEndpoint"

type

type: object

className

className: string = "LiveEventEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

protocol

protocol: object

serializedName

serializedName: string = "protocol"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const LiveEventInput

LiveEventInput: object

The Live Event input.

Optional accessControl

The access control for LiveEvent Input.

Optional accessToken

accessToken: undefined | string

A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value.

Optional endpoints

endpoints: LiveEventEndpoint[]

The input endpoints for the Live Event.

Optional keyFrameIntervalDuration

keyFrameIntervalDuration: undefined | string

ISO 8601 timespan duration of the key frame interval duration.

streamingProtocol

streamingProtocol: LiveEventInputProtocol

The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. Possible values include: 'FragmentedMP4', 'RTMP'

serializedName

serializedName: string = "LiveEventInput"

type

type: object

className

className: string = "LiveEventInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessControl

accessControl: object

serializedName

serializedName: string = "accessControl"

type

type: object

className

className: string = "LiveEventInputAccessControl"

name

name: "Composite" = "Composite"

accessToken

accessToken: object

serializedName

serializedName: string = "accessToken"

type

type: object

name

name: "String" = "String"

endpoints

endpoints: object

serializedName

serializedName: string = "endpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LiveEventEndpoint"

name

name: "Composite" = "Composite"

keyFrameIntervalDuration

keyFrameIntervalDuration: object

serializedName

serializedName: string = "keyFrameIntervalDuration"

type

type: object

name

name: "String" = "String"

streamingProtocol

streamingProtocol: object

required

required: true = true

serializedName

serializedName: string = "streamingProtocol"

type

type: object

allowedValues

allowedValues: string[] = ["FragmentedMP4","RTMP"]

name

name: "Enum" = "Enum"

Const LiveEventInputAccessControl

LiveEventInputAccessControl: object

The IP access control for Live Event Input.

Optional ip

The IP access control properties.

serializedName

serializedName: string = "LiveEventInputAccessControl"

type

type: object

className

className: string = "LiveEventInputAccessControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ip

ip: object

serializedName

serializedName: string = "ip"

type

type: object

className

className: string = "IPAccessControl"

name

name: "Composite" = "Composite"

Const LiveEventListResult

LiveEventListResult: object
interface

The LiveEvent list result.

summary

LiveEventListResult

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatacount

odatacount: undefined | number

The number of result.

Optional odatanextLink

odatanextLink: undefined | string

Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs.

serializedName

serializedName: string = "LiveEventListResult"

__@iterator

  • Iterator

    Returns IterableIterator<LiveEvent>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LiveEvent>[]

      Additional items to add to the end of array1.

    Returns LiveEvent[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LiveEvent[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LiveEvent]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LiveEvent]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LiveEvent, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LiveEvent

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LiveEvent[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LiveEvent[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LiveEvent | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LiveEvent | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LiveEvent, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LiveEvent

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LiveEvent, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LiveEvent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LiveEvent, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LiveEvent

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LiveEvent | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LiveEvent[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LiveEvent
  • reduce(callbackfn: function, initialValue: LiveEvent): LiveEvent
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns LiveEvent

  • Parameters

    Returns LiveEvent

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LiveEvent, currentIndex: number, array: LiveEvent[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LiveEvent
  • reduceRight(callbackfn: function, initialValue: LiveEvent): LiveEvent
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns LiveEvent

  • Parameters

    Returns LiveEvent

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: LiveEvent, currentIndex: number, array: LiveEvent[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LiveEvent[]

shift

  • Removes the first element from an array and returns it.

    Returns LiveEvent | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LiveEvent[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LiveEvent[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LiveEvent[]
  • splice(start: number, deleteCount: number, ...items: LiveEvent[]): LiveEvent[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LiveEvent[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LiveEvent[]

      Elements to insert into the array in place of the deleted elements.

    Returns LiveEvent[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LiveEvent[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LiveEvent>

type

type: object

className

className: string = "LiveEventListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatacount

odatacount: object

serializedName

serializedName: string = "@odata\.count"

type

type: object

name

name: "Number" = "Number"

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LiveEvent"

name

name: "Composite" = "Composite"

Const LiveEventPreview

LiveEventPreview: object

The Live Event preview.

Optional accessControl

The access control for LiveEvent preview.

Optional alternativeMediaId

alternativeMediaId: undefined | string

An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field.

Optional endpoints

endpoints: LiveEventEndpoint[]

The endpoints for preview.

Optional previewLocator

previewLocator: undefined | string

The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created.

Optional streamingPolicyName

streamingPolicyName: undefined | string

The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated.

serializedName

serializedName: string = "LiveEventPreview"

type

type: object

className

className: string = "LiveEventPreview"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessControl

accessControl: object

serializedName

serializedName: string = "accessControl"

type

type: object

className

className: string = "LiveEventPreviewAccessControl"

name

name: "Composite" = "Composite"

alternativeMediaId

alternativeMediaId: object

serializedName

serializedName: string = "alternativeMediaId"

type

type: object

name

name: "String" = "String"

endpoints

endpoints: object

serializedName

serializedName: string = "endpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LiveEventEndpoint"

name

name: "Composite" = "Composite"

previewLocator

previewLocator: object

serializedName

serializedName: string = "previewLocator"

type

type: object

name

name: "String" = "String"

streamingPolicyName

streamingPolicyName: object

serializedName

serializedName: string = "streamingPolicyName"

type

type: object

name

name: "String" = "String"

Const LiveEventPreviewAccessControl

LiveEventPreviewAccessControl: object

The IP access control for Live Event preview.

Optional ip

The IP access control properties.

serializedName

serializedName: string = "LiveEventPreviewAccessControl"

type

type: object

className

className: string = "LiveEventPreviewAccessControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ip

ip: object

serializedName

serializedName: string = "ip"

type

type: object

className

className: string = "IPAccessControl"

name

name: "Composite" = "Composite"

Const LiveOutput

LiveOutput: object

The Live Output.

archiveWindowLength

archiveWindowLength: string

ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content.

assetName

assetName: string

The asset name.

Optional created

created: Date

The exact time the Live Output was created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

The description of the Live Output.

Optional hls

hls: Hls

The HLS configuration.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The exact time the Live Output was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional manifestName

manifestName: undefined | string

The manifest file name. If not provided, the service will generate one automatically.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputSnapTime

outputSnapTime: undefined | number

The output snapshot time.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the Live Output. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceState

The resource state of the Live Output. Possible values include: 'Creating', 'Running', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LiveOutput"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LiveOutput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

archiveWindowLength

archiveWindowLength: object

required

required: true = true

serializedName

serializedName: string = "properties.archiveWindowLength"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

assetName

assetName: object

required

required: true = true

serializedName

serializedName: string = "properties.assetName"

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

hls

hls: object

serializedName

serializedName: string = "properties.hls"

type

type: object

className

className: string = "Hls"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

manifestName

manifestName: object

serializedName

serializedName: string = "properties.manifestName"

type

type: object

name

name: "String" = "String"

outputSnapTime

outputSnapTime: object

serializedName

serializedName: string = "properties.outputSnapTime"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceState

resourceState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceState"

type

type: object

allowedValues

allowedValues: string[] = ["Creating","Running","Deleting"]

name

name: "Enum" = "Enum"

Const LiveOutputListResult

LiveOutputListResult: object
interface

The LiveOutput list result.

summary

LiveOutputListResult

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatacount

odatacount: undefined | number

The number of result.

Optional odatanextLink

odatanextLink: undefined | string

Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs.

serializedName

serializedName: string = "LiveOutputListResult"

__@iterator

  • Iterator

    Returns IterableIterator<LiveOutput>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LiveOutput>[]

      Additional items to add to the end of array1.

    Returns LiveOutput[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LiveOutput[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, LiveOutput]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LiveOutput]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LiveOutput, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LiveOutput

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LiveOutput[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LiveOutput[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LiveOutput | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LiveOutput | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: LiveOutput, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LiveOutput

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: LiveOutput, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LiveOutput

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: LiveOutput, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LiveOutput

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LiveOutput | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: LiveOutput[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): LiveOutput
  • reduce(callbackfn: function, initialValue: LiveOutput): LiveOutput
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LiveOutput

  • Parameters

    Returns LiveOutput

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): LiveOutput
  • reduceRight(callbackfn: function, initialValue: LiveOutput): LiveOutput
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LiveOutput

  • Parameters

    Returns LiveOutput

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LiveOutput[]

shift

  • Removes the first element from an array and returns it.

    Returns LiveOutput | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): LiveOutput[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LiveOutput[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): LiveOutput[]
  • splice(start: number, deleteCount: number, ...items: LiveOutput[]): LiveOutput[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LiveOutput[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LiveOutput[]

      Elements to insert into the array in place of the deleted elements.

    Returns LiveOutput[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: LiveOutput[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LiveOutput>

type

type: object

className

className: string = "LiveOutputListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatacount

odatacount: object

serializedName

serializedName: string = "@odata\.count"

type

type: object

name

name: "Number" = "Number"

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LiveOutput"

name

name: "Composite" = "Composite"

Const Location

Location: object

An interface representing Location.

name

name: string

serializedName

serializedName: string = "Location"

type

type: object

className

className: string = "Location"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const MediaService

MediaService: object

A Media Services account.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The Azure Region of the resource.

Optional mediaServiceId

mediaServiceId: undefined | string

The Media Services account ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageAccounts

storageAccounts: StorageAccount[]

The storage accounts for this resource.

Optional tags

tags: undefined | object

Resource tags.

serializedName

serializedName: string = "MediaService"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "MediaService"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mediaServiceId

mediaServiceId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.mediaServiceId"

type

type: object

name

name: "Uuid" = "Uuid"

storageAccounts

storageAccounts: object

serializedName

serializedName: string = "properties.storageAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StorageAccount"

name

name: "Composite" = "Composite"

Const MediaServiceCollection

MediaServiceCollection: object
interface

A collection of MediaService items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "MediaServiceCollection"

__@iterator

  • Iterator

    Returns IterableIterator<MediaService>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MediaService>[]

      Additional items to add to the end of array1.

    Returns MediaService[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MediaService[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MediaService]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MediaService, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MediaService

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MediaService[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MediaService[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MediaService | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns MediaService | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MediaService, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MediaService

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MediaService, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MediaService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MediaService, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MediaService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns MediaService | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns MediaService

  • Parameters

    Returns MediaService

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MediaService
  • reduceRight(callbackfn: function, initialValue: MediaService): MediaService
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns MediaService

  • Parameters

    Returns MediaService

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns MediaService[]

shift

  • Removes the first element from an array and returns it.

    Returns MediaService | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MediaService[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MediaService[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MediaService[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MediaService[]

      Elements to insert into the array in place of the deleted elements.

    Returns MediaService[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MediaService[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<MediaService>

type

type: object

className

className: string = "MediaServiceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MediaService"

name

name: "Composite" = "Composite"

Const Metric

Metric: object

A metric emitted by service.

Optional aggregationType

aggregationType: MetricAggregationType

The metric aggregation type. Possible values include: 'Average', 'Count', 'Total' NOTE: This property will not be serialized. It can only be populated by the server.

Optional dimensions

dimensions: MetricDimension[]

The metric dimensions. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayDescription

displayDescription: undefined | string

The metric display description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

The metric display name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The metric name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Metric"

type

type: object

className

className: string = "Metric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationType

aggregationType: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "aggregationType"

type

type: object

name

name: "String" = "String"

dimensions

dimensions: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

displayDescription

displayDescription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "displayDescription"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

unit

unit: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const MetricDimension

MetricDimension: object

A metric dimension.

Optional displayName

displayName: undefined | string

The display name for the dimension. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The metric dimension name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional toBeExportedForShoebox

toBeExportedForShoebox: undefined | false | true

Whether to export metric to shoebox. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricDimension"

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

toBeExportedForShoebox

toBeExportedForShoebox: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "toBeExportedForShoebox"

type

type: object

name

name: "Boolean" = "Boolean"

Const MetricProperties

MetricProperties: object

Metric properties.

Optional serviceSpecification

serviceSpecification: ServiceSpecification

The service specifications. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricProperties"

type

type: object

className

className: string = "MetricProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceSpecification

serviceSpecification: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "serviceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

name: "Composite" = "Composite"

Const Mp4Format

Mp4Format: object

Describes the properties for an output ISO MP4 file.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.Mp4Format"

Polymorphic Discriminator

Optional outputFiles

outputFiles: OutputFile[]

The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together .

serializedName

serializedName: string = "#Microsoft.Media.Mp4Format"

type

type: object

className

className: string = "Mp4Format"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

Const MultiBitrateFormat

MultiBitrateFormat: object

Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.MultiBitrateFormat"

Polymorphic Discriminator

Optional outputFiles

outputFiles: OutputFile[]

The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together .

serializedName

serializedName: string = "#Microsoft.Media.MultiBitrateFormat"

type

type: object

className

className: string = "MultiBitrateFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

outputFiles

outputFiles: object

serializedName

serializedName: string = "outputFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

Const NoEncryption

NoEncryption: object

Class for NoEncryption scheme

Optional enabledProtocols

enabledProtocols: EnabledProtocols

Representing supported protocols

serializedName

serializedName: string = "NoEncryption"

type

type: object

className

className: string = "NoEncryption"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabledProtocols

enabledProtocols: object

serializedName

serializedName: string = "enabledProtocols"

type

type: object

className

className: string = "EnabledProtocols"

name

name: "Composite" = "Composite"

Const ODataError

ODataError: object

Information about an error.

Optional code

code: undefined | string

A language-independent error name.

Optional details

details: ODataError[]

The error details.

Optional message

message: undefined | string

The error message.

Optional target

target: undefined | string

The target of the error (for example, the name of the property in error).

serializedName

serializedName: string = "ODataError"

type

type: object

className

className: string = "ODataError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ODataError"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object

An operation.

Optional display

The operation display name.

name

name: string

The operation name.

Optional origin

origin: undefined | string

Origin of the operation.

Optional properties

properties: MetricProperties

Operation properties format.

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "MetricProperties"

name

name: "Composite" = "Composite"

Const OperationCollection

OperationCollection: object
interface

A collection of Operation items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "OperationCollection"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationDisplay

OperationDisplay: object

Operation details.

Optional description

description: undefined | string

The operation description.

Optional operation

operation: undefined | string

The operation type.

Optional provider

provider: undefined | string

The service provider.

Optional resource

resource: undefined | string

Resource on which the operation is performed.

serializedName

serializedName: string = "OperationDisplay"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OutputFile

OutputFile: object

Represents an output file produced.

labels

labels: string[]

The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1.

serializedName

serializedName: string = "OutputFile"

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

labels

labels: object

required

required: true = true

serializedName

serializedName: string = "labels"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const Overlay

Overlay: object

Base type for all overlays - image, audio or video.

Optional audioGainLevel

audioGainLevel: undefined | number

The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.

Optional end

end: undefined | string

The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media.

Optional fadeInDuration

fadeInDuration: undefined | string

The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).

Optional fadeOutDuration

fadeOutDuration: undefined | string

The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).

inputLabel

inputLabel: string

The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats.

odatatype

odatatype: "Overlay"

Polymorphic Discriminator

Optional start

start: undefined | string

The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video.

serializedName

serializedName: string = "Overlay"

type

type: object

className

className: string = "Overlay"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Overlay"

modelProperties

modelProperties: object

audioGainLevel

audioGainLevel: object

serializedName

serializedName: string = "audioGainLevel"

type

type: object

name

name: "Number" = "Number"

end

end: object

serializedName

serializedName: string = "end"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

fadeInDuration

fadeInDuration: object

serializedName

serializedName: string = "fadeInDuration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

fadeOutDuration

fadeOutDuration: object

serializedName

serializedName: string = "fadeOutDuration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

inputLabel

inputLabel: object

required

required: true = true

serializedName

serializedName: string = "inputLabel"

type

type: object

name

name: "String" = "String"

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

start

start: object

serializedName

serializedName: string = "start"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const PngFormat

PngFormat: object

Describes the settings for producing PNG thumbnails.

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.PngFormat"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.PngFormat"

type

type: object

className

className: string = "PngFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

Const PngImage

PngImage: object

Describes the properties for producing a series of PNG images from the input video.

Optional keyFrameInterval

keyFrameInterval: undefined | string

The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

Optional layers

layers: PngLayer[]

A collection of output PNG image layers to be produced by the encoder.

odatatype

odatatype: "#Microsoft.Media.PngImage"

Polymorphic Discriminator

Optional range

range: undefined | string

The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).

start

start: string

The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video.

Optional step

step: undefined | string

The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).

Optional stretchMode

stretchMode: StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit'

serializedName

serializedName: string = "#Microsoft.Media.PngImage"

type

type: object

className

className: string = "PngImage"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

layers

layers: object

serializedName

serializedName: string = "layers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PngLayer"

name

name: "Composite" = "Composite"

Const PngLayer

PngLayer: object

Describes the settings to produce a PNG image from the input video.

Optional height

height: undefined | string

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

Optional label

label: undefined | string

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

odatatype

odatatype: "#Microsoft.Media.PngLayer"

Polymorphic Discriminator

Optional width

width: undefined | string

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

serializedName

serializedName: string = "#Microsoft.Media.PngLayer"

type

type: object

className

className: string = "PngLayer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Layer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Layer"

modelProperties

modelProperties: object

Const PresentationTimeRange

PresentationTimeRange: object

The presentation time range, this is asset related and not recommended for Account Filter.

Optional endTimestamp

endTimestamp: undefined | number

The absolute end time boundary.

Optional forceEndTimestamp

forceEndTimestamp: undefined | false | true

The indicator of forcing exsiting of end time stamp.

Optional liveBackoffDuration

liveBackoffDuration: undefined | number

The relative to end right edge.

Optional presentationWindowDuration

presentationWindowDuration: undefined | number

The relative to end sliding window.

Optional startTimestamp

startTimestamp: undefined | number

The absolute start time boundary.

Optional timescale

timescale: undefined | number

The time scale of time stamps.

serializedName

serializedName: string = "PresentationTimeRange"

type

type: object

className

className: string = "PresentationTimeRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTimestamp

endTimestamp: object

serializedName

serializedName: string = "endTimestamp"

type

type: object

name

name: "Number" = "Number"

forceEndTimestamp

forceEndTimestamp: object

serializedName

serializedName: string = "forceEndTimestamp"

type

type: object

name

name: "Boolean" = "Boolean"

liveBackoffDuration

liveBackoffDuration: object

serializedName

serializedName: string = "liveBackoffDuration"

type

type: object

name

name: "Number" = "Number"

presentationWindowDuration

presentationWindowDuration: object

serializedName

serializedName: string = "presentationWindowDuration"

type

type: object

name

name: "Number" = "Number"

startTimestamp

startTimestamp: object

serializedName

serializedName: string = "startTimestamp"

type

type: object

name

name: "Number" = "Number"

timescale

timescale: object

serializedName

serializedName: string = "timescale"

type

type: object

name

name: "Number" = "Number"

Const Preset

Preset: object

Base type for all Presets, which define the recipe or instructions on how the input media files should be processed.

odatatype

odatatype: "Preset"

Polymorphic Discriminator

serializedName

serializedName: string = "Preset"

type

type: object

className

className: string = "Preset"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: true = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const Provider

Provider: object

A resource provider.

providerName

providerName: string

The provider name.

serializedName

serializedName: string = "Provider"

type

type: object

className

className: string = "Provider"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

providerName

providerName: object

required

required: true = true

serializedName

serializedName: string = "providerName"

type

type: object

name

name: "String" = "String"

Const ProxyResource

ProxyResource: object

The resource model definition for a ARM proxy resource.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyResource"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const Rectangle

Rectangle: object

Describes the properties of a rectangular window applied to the input media before processing it.

Optional height

height: undefined | string

The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).

Optional left

left: undefined | string

The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).

Optional top

top: undefined | string

The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).

Optional width

width: undefined | string

The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).

serializedName

serializedName: string = "Rectangle"

type

type: object

className

className: string = "Rectangle"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

height

height: object

serializedName

serializedName: string = "height"

type

type: object

name

name: "String" = "String"

left

left: object

serializedName

serializedName: string = "left"

type

type: object

name

name: "String" = "String"

top

top: object

serializedName

serializedName: string = "top"

type

type: object

name

name: "String" = "String"

width

width: object

serializedName

serializedName: string = "width"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

The core properties of ARM resources.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ServiceSpecification

ServiceSpecification: object

The service metric specifications.

Optional metricSpecifications

metricSpecifications: Metric[]

List of metric specifications. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ServiceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricSpecifications

metricSpecifications: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "metricSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Metric"

name

name: "Composite" = "Composite"

Const StandardEncoderPreset

StandardEncoderPreset: object

Describes all the settings to be used when encoding the input video with the Standard Encoder.

codecs

codecs: CodecUnion[]

The list of codecs to be used when encoding the input video.

Optional filters

filters: Filters

One or more filtering operations that are applied to the input media before encoding.

formats

formats: FormatUnion[]

The list of outputs to be produced by the encoder.

odatatype

odatatype: "#Microsoft.Media.StandardEncoderPreset"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.StandardEncoderPreset"

type

type: object

className

className: string = "StandardEncoderPreset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Preset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

codecs

codecs: object

required

required: true = true

serializedName

serializedName: string = "codecs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Codec"

name

name: "Composite" = "Composite"

filters

filters: object

serializedName

serializedName: string = "filters"

type

type: object

className

className: string = "Filters"

name

name: "Composite" = "Composite"

formats

formats: object

required

required: true = true

serializedName

serializedName: string = "formats"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Format"

name

name: "Composite" = "Composite"

Const StorageAccount

StorageAccount: object

The storage account details.

Optional id

id: undefined | string

The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts.

serializedName

serializedName: string = "StorageAccount"

type

type: object

The type of the storage account. Possible values include: 'Primary', 'Secondary'

className

className: string = "StorageAccount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const StorageEncryptedAssetDecryptionData

StorageEncryptedAssetDecryptionData: object

Data needed to decrypt asset files encrypted with legacy storage encryption.

Optional assetFileEncryptionMetadata

assetFileEncryptionMetadata: AssetFileEncryptionMetadata[]

Asset File encryption metadata.

Optional key

key: Uint8Array

The Asset File storage encryption key.

serializedName

serializedName: string = "StorageEncryptedAssetDecryptionData"

type

type: object

className

className: string = "StorageEncryptedAssetDecryptionData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assetFileEncryptionMetadata

assetFileEncryptionMetadata: object

serializedName

serializedName: string = "assetFileEncryptionMetadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AssetFileEncryptionMetadata"

name

name: "Composite" = "Composite"

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: "ByteArray" = "ByteArray"

Const StreamingEndpoint

StreamingEndpoint: object

The StreamingEndpoint.

Optional accessControl

The access control definition of the StreamingEndpoint.

Optional availabilitySetName

availabilitySetName: undefined | string

The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time.

Optional cdnEnabled

cdnEnabled: undefined | false | true

The CDN enabled flag.

Optional cdnProfile

cdnProfile: undefined | string

The CDN profile name.

Optional cdnProvider

cdnProvider: undefined | string

The CDN provider name.

Optional created

created: Date

The exact time the StreamingEndpoint was created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional crossSiteAccessPolicies

crossSiteAccessPolicies: CrossSiteAccessPolicies

The StreamingEndpoint access policies.

Optional customHostNames

customHostNames: string[]

The custom host names of the StreamingEndpoint

Optional description

description: undefined | string

The StreamingEndpoint description.

Optional freeTrialEndTime

freeTrialEndTime: Date

The free trial expiration time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostName

hostName: undefined | string

The StreamingEndpoint host name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The exact time the StreamingEndpoint was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The Azure Region of the resource.

Optional maxCacheAge

maxCacheAge: undefined | number

Max cache age

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string

The provisioning state of the StreamingEndpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceState

The resource state of the StreamingEndpoint. Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', 'Deleting', 'Scaling' NOTE: This property will not be serialized. It can only be populated by the server.

scaleUnits

scaleUnits: number

The number of scale units. Use the Scale operation to adjust this value.

Optional tags

tags: undefined | object

Resource tags.

serializedName

serializedName: string = "StreamingEndpoint"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StreamingEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessControl

accessControl: object

serializedName

serializedName: string = "properties.accessControl"

type

type: object

className

className: string = "StreamingEndpointAccessControl"

name

name: "Composite" = "Composite"

availabilitySetName

availabilitySetName: object

serializedName

serializedName: string = "properties.availabilitySetName"

type

type: object

name

name: "String" = "String"

cdnEnabled

cdnEnabled: object

serializedName

serializedName: string = "properties.cdnEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

cdnProfile

cdnProfile: object

serializedName

serializedName: string = "properties.cdnProfile"

type

type: object

name

name: "String" = "String"

cdnProvider

cdnProvider: object

serializedName

serializedName: string = "properties.cdnProvider"

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

crossSiteAccessPolicies

crossSiteAccessPolicies: object

serializedName

serializedName: string = "properties.crossSiteAccessPolicies"

type

type: object

className

className: string = "CrossSiteAccessPolicies"

name

name: "Composite" = "Composite"

customHostNames

customHostNames: object

serializedName

serializedName: string = "properties.customHostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

freeTrialEndTime

freeTrialEndTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.freeTrialEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

hostName

hostName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostName"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

maxCacheAge

maxCacheAge: object

serializedName

serializedName: string = "properties.maxCacheAge"

type

type: object

name

name: "Number" = "Number"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

resourceState

resourceState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceState"

type

type: object

allowedValues

allowedValues: string[] = ["Stopped","Starting","Running","Stopping","Deleting","Scaling"]

name

name: "Enum" = "Enum"

scaleUnits

scaleUnits: object

required

required: true = true

serializedName

serializedName: string = "properties.scaleUnits"

type

type: object

name

name: "Number" = "Number"

Const StreamingEndpointAccessControl

StreamingEndpointAccessControl: object

StreamingEndpoint access control definition.

Optional akamai

The access control of Akamai

Optional ip

The IP access control of the StreamingEndpoint.

serializedName

serializedName: string = "StreamingEndpointAccessControl"

type

type: object

className

className: string = "StreamingEndpointAccessControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

akamai

akamai: object

serializedName

serializedName: string = "akamai"

type

type: object

className

className: string = "AkamaiAccessControl"

name

name: "Composite" = "Composite"

ip

ip: object

serializedName

serializedName: string = "ip"

type

type: object

className

className: string = "IPAccessControl"

name

name: "Composite" = "Composite"

Const StreamingEndpointListResult

StreamingEndpointListResult: object
interface

The StreamingEndpoint list result.

summary

StreamingEndpointListResult

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatacount

odatacount: undefined | number

The number of result.

Optional odatanextLink

odatanextLink: undefined | string

Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints.

serializedName

serializedName: string = "StreamingEndpointListResult"

__@iterator

  • Iterator

    Returns IterableIterator<StreamingEndpoint>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<StreamingEndpoint>[]

      Additional items to add to the end of array1.

    Returns StreamingEndpoint[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StreamingEndpoint[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StreamingEndpoint]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: StreamingEndpoint, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StreamingEndpoint

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): StreamingEndpoint[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns StreamingEndpoint[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StreamingEndpoint | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns StreamingEndpoint | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: StreamingEndpoint, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StreamingEndpoint

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StreamingEndpoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: StreamingEndpoint, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StreamingEndpoint

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns StreamingEndpoint | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingEndpoint

  • Parameters

    Returns StreamingEndpoint

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingEndpoint

  • Parameters

    Returns StreamingEndpoint

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns StreamingEndpoint[]

shift

  • Removes the first element from an array and returns it.

    Returns StreamingEndpoint | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StreamingEndpoint[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StreamingEndpoint[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StreamingEndpoint[]

      Elements to insert into the array in place of the deleted elements.

    Returns StreamingEndpoint[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<StreamingEndpoint>

type

type: object

className

className: string = "StreamingEndpointListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatacount

odatacount: object

serializedName

serializedName: string = "@odata\.count"

type

type: object

name

name: "Number" = "Number"

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingEndpoint"

name

name: "Composite" = "Composite"

Const StreamingEntityScaleUnit

StreamingEntityScaleUnit: object

scale units definition

Optional scaleUnit

scaleUnit: undefined | number

The scale unit number of the StreamingEndpoint.

serializedName

serializedName: string = "StreamingEntityScaleUnit"

type

type: object

className

className: string = "StreamingEntityScaleUnit"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

scaleUnit

scaleUnit: object

serializedName

serializedName: string = "scaleUnit"

type

type: object

name

name: "Number" = "Number"

Const StreamingLocator

StreamingLocator: object

A Streaming Locator resource

Optional alternativeMediaId

alternativeMediaId: undefined | string

Alternative Media ID of this Streaming Locator

assetName

assetName: string

Asset Name

Optional contentKeys

The ContentKeys used by this Streaming Locator.

Optional created

created: Date

The creation time of the Streaming Locator. NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultContentKeyPolicyName

defaultContentKeyPolicyName: undefined | string

Name of the default ContentKeyPolicy used by this Streaming Locator.

Optional endTime

endTime: Date

The end time of the Streaming Locator.

Optional filters

filters: string[]

A list of asset or account filters which apply to this streaming locator

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

The start time of the Streaming Locator.

Optional streamingLocatorId

streamingLocatorId: undefined | string

The StreamingLocatorId of the Streaming Locator.

streamingPolicyName

streamingPolicyName: string

Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'

serializedName

serializedName: string = "StreamingLocator"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StreamingLocator"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alternativeMediaId

alternativeMediaId: object

serializedName

serializedName: string = "properties.alternativeMediaId"

type

type: object

name

name: "String" = "String"

assetName

assetName: object

required

required: true = true

serializedName

serializedName: string = "properties.assetName"

type

type: object

name

name: "String" = "String"

contentKeys

contentKeys: object

serializedName

serializedName: string = "properties.contentKeys"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingLocatorContentKey"

name

name: "Composite" = "Composite"

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

defaultContentKeyPolicyName

defaultContentKeyPolicyName: object

serializedName

serializedName: string = "properties.defaultContentKeyPolicyName"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

filters

filters: object

serializedName

serializedName: string = "properties.filters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

streamingLocatorId

streamingLocatorId: object

serializedName

serializedName: string = "properties.streamingLocatorId"

type

type: object

name

name: "Uuid" = "Uuid"

streamingPolicyName

streamingPolicyName: object

required

required: true = true

serializedName

serializedName: string = "properties.streamingPolicyName"

type

type: object

name

name: "String" = "String"

Const StreamingLocatorCollection

StreamingLocatorCollection: object
interface

A collection of StreamingLocator items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "StreamingLocatorCollection"

__@iterator

  • Iterator

    Returns IterableIterator<StreamingLocator>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<StreamingLocator>[]

      Additional items to add to the end of array1.

    Returns StreamingLocator[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StreamingLocator[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StreamingLocator]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: StreamingLocator, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StreamingLocator

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): StreamingLocator[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns StreamingLocator[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StreamingLocator | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns StreamingLocator | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: StreamingLocator, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StreamingLocator

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: StreamingLocator, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StreamingLocator

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: StreamingLocator, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StreamingLocator

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns StreamingLocator | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingLocator

  • Parameters

    Returns StreamingLocator

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingLocator

  • Parameters

    Returns StreamingLocator

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns StreamingLocator[]

shift

  • Removes the first element from an array and returns it.

    Returns StreamingLocator | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): StreamingLocator[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StreamingLocator[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StreamingLocator[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StreamingLocator[]

      Elements to insert into the array in place of the deleted elements.

    Returns StreamingLocator[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: StreamingLocator[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<StreamingLocator>

type

type: object

className

className: string = "StreamingLocatorCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingLocator"

name

name: "Composite" = "Composite"

Const StreamingLocatorContentKey

StreamingLocatorContentKey: object

Class for content key in Streaming Locator

id

id: string

ID of Content Key

Optional labelReferenceInStreamingPolicy

labelReferenceInStreamingPolicy: undefined | string

Label of Content Key as specified in the Streaming Policy

Optional policyName

policyName: undefined | string

ContentKeyPolicy used by Content Key NOTE: This property will not be serialized. It can only be populated by the server.

Optional tracks

tracks: TrackSelection[]

Tracks which use this Content Key NOTE: This property will not be serialized. It can only be populated by the server.

Optional value

value: undefined | string

Value of Content Key

serializedName

serializedName: string = "StreamingLocatorContentKey"

Optional type

type: object

Encryption type of Content Key. Possible values include: 'CommonEncryptionCenc', 'CommonEncryptionCbcs', 'EnvelopeEncryption' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StreamingLocatorContentKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "Uuid" = "Uuid"

labelReferenceInStreamingPolicy

labelReferenceInStreamingPolicy: object

serializedName

serializedName: string = "labelReferenceInStreamingPolicy"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

tracks

tracks: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

type

type: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const StreamingPath

StreamingPath: object

Class of paths for streaming

encryptionScheme

encryptionScheme: EncryptionScheme

Encryption scheme. Possible values include: 'NoEncryption', 'EnvelopeEncryption', 'CommonEncryptionCenc', 'CommonEncryptionCbcs'

Optional paths

paths: string[]

Streaming paths for each protocol and encryptionScheme pair

streamingProtocol

Streaming protocol. Possible values include: 'Hls', 'Dash', 'SmoothStreaming', 'Download'

serializedName

serializedName: string = "StreamingPath"

type

type: object

className

className: string = "StreamingPath"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionScheme

encryptionScheme: object

required

required: true = true

serializedName

serializedName: string = "encryptionScheme"

type

type: object

name

name: "String" = "String"

paths

paths: object

serializedName

serializedName: string = "paths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

streamingProtocol

streamingProtocol: object

required

required: true = true

serializedName

serializedName: string = "streamingProtocol"

type

type: object

name

name: "String" = "String"

Const StreamingPolicy

StreamingPolicy: object

A Streaming Policy resource

Optional commonEncryptionCbcs

commonEncryptionCbcs: CommonEncryptionCbcs

Configuration of CommonEncryptionCbcs

Optional commonEncryptionCenc

commonEncryptionCenc: CommonEncryptionCenc

Configuration of CommonEncryptionCenc

Optional created

created: Date

Creation time of Streaming Policy NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultContentKeyPolicyName

defaultContentKeyPolicyName: undefined | string

Default ContentKey used by current Streaming Policy

Optional envelopeEncryption

envelopeEncryption: EnvelopeEncryption

Configuration of EnvelopeEncryption

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional noEncryption

noEncryption: NoEncryption

Configurations of NoEncryption

serializedName

serializedName: string = "StreamingPolicy"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "StreamingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commonEncryptionCbcs

commonEncryptionCbcs: object

serializedName

serializedName: string = "properties.commonEncryptionCbcs"

type

type: object

className

className: string = "CommonEncryptionCbcs"

name

name: "Composite" = "Composite"

commonEncryptionCenc

commonEncryptionCenc: object

serializedName

serializedName: string = "properties.commonEncryptionCenc"

type

type: object

className

className: string = "CommonEncryptionCenc"

name

name: "Composite" = "Composite"

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

defaultContentKeyPolicyName

defaultContentKeyPolicyName: object

serializedName

serializedName: string = "properties.defaultContentKeyPolicyName"

type

type: object

name

name: "String" = "String"

envelopeEncryption

envelopeEncryption: object

serializedName

serializedName: string = "properties.envelopeEncryption"

type

type: object

className

className: string = "EnvelopeEncryption"

name

name: "Composite" = "Composite"

noEncryption

noEncryption: object

serializedName

serializedName: string = "properties.noEncryption"

type

type: object

className

className: string = "NoEncryption"

name

name: "Composite" = "Composite"

Const StreamingPolicyCollection

StreamingPolicyCollection: object
interface

A collection of StreamingPolicy items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "StreamingPolicyCollection"

__@iterator

  • Iterator

    Returns IterableIterator<StreamingPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<StreamingPolicy>[]

      Additional items to add to the end of array1.

    Returns StreamingPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StreamingPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StreamingPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: StreamingPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StreamingPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): StreamingPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns StreamingPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StreamingPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns StreamingPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: StreamingPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StreamingPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: StreamingPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StreamingPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: StreamingPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StreamingPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns StreamingPolicy | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingPolicy

  • Parameters

    Returns StreamingPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns StreamingPolicy

  • Parameters

    Returns StreamingPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns StreamingPolicy[]

shift

  • Removes the first element from an array and returns it.

    Returns StreamingPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): StreamingPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StreamingPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StreamingPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StreamingPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns StreamingPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: StreamingPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<StreamingPolicy>

type

type: object

className

className: string = "StreamingPolicyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingPolicy"

name

name: "Composite" = "Composite"

Const StreamingPolicyContentKey

StreamingPolicyContentKey: object

Class to specify properties of content key

Optional label

label: undefined | string

Label can be used to specify Content Key when creating a Streaming Locator

Optional policyName

policyName: undefined | string

Policy used by Content Key

Optional tracks

tracks: TrackSelection[]

Tracks which use this content key

serializedName

serializedName: string = "StreamingPolicyContentKey"

type

type: object

className

className: string = "StreamingPolicyContentKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

label

label: object

serializedName

serializedName: string = "label"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

tracks

tracks: object

serializedName

serializedName: string = "tracks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

Const StreamingPolicyContentKeys

StreamingPolicyContentKeys: object

Class to specify properties of all content keys in Streaming Policy

Optional defaultKey

defaultKey: DefaultKey

Default content key for an encryption scheme

Optional keyToTrackMappings

keyToTrackMappings: StreamingPolicyContentKey[]

Representing tracks needs separate content key

serializedName

serializedName: string = "StreamingPolicyContentKeys"

type

type: object

className

className: string = "StreamingPolicyContentKeys"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultKey

defaultKey: object

serializedName

serializedName: string = "defaultKey"

type

type: object

className

className: string = "DefaultKey"

name

name: "Composite" = "Composite"

keyToTrackMappings

keyToTrackMappings: object

serializedName

serializedName: string = "keyToTrackMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StreamingPolicyContentKey"

name

name: "Composite" = "Composite"

Const StreamingPolicyFairPlayConfiguration

StreamingPolicyFairPlayConfiguration: object

Class to specify configurations of FairPlay in Streaming Policy

allowPersistentLicense

allowPersistentLicense: boolean

All license to be persistent or not

Optional customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: undefined | string

Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

serializedName

serializedName: string = "StreamingPolicyFairPlayConfiguration"

type

type: object

className

className: string = "StreamingPolicyFairPlayConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowPersistentLicense

allowPersistentLicense: object

required

required: true = true

serializedName

serializedName: string = "allowPersistentLicense"

type

type: object

name

name: "Boolean" = "Boolean"

customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: object

serializedName

serializedName: string = "customLicenseAcquisitionUrlTemplate"

type

type: object

name

name: "String" = "String"

Const StreamingPolicyPlayReadyConfiguration

StreamingPolicyPlayReadyConfiguration: object

Class to specify configurations of PlayReady in Streaming Policy

Optional customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: undefined | string

Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

Optional playReadyCustomAttributes

playReadyCustomAttributes: undefined | string

Custom attributes for PlayReady

serializedName

serializedName: string = "StreamingPolicyPlayReadyConfiguration"

type

type: object

className

className: string = "StreamingPolicyPlayReadyConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: object

serializedName

serializedName: string = "customLicenseAcquisitionUrlTemplate"

type

type: object

name

name: "String" = "String"

playReadyCustomAttributes

playReadyCustomAttributes: object

serializedName

serializedName: string = "playReadyCustomAttributes"

type

type: object

name

name: "String" = "String"

Const StreamingPolicyWidevineConfiguration

StreamingPolicyWidevineConfiguration: object

Class to specify configurations of Widevine in Streaming Policy

Optional customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: undefined | string

Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

serializedName

serializedName: string = "StreamingPolicyWidevineConfiguration"

type

type: object

className

className: string = "StreamingPolicyWidevineConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

customLicenseAcquisitionUrlTemplate

customLicenseAcquisitionUrlTemplate: object

serializedName

serializedName: string = "customLicenseAcquisitionUrlTemplate"

type

type: object

name

name: "String" = "String"

Const SubscriptionMediaService

SubscriptionMediaService: object

A Media Services account.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The Azure Region of the resource.

Optional mediaServiceId

mediaServiceId: undefined | string

The Media Services account ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageAccounts

storageAccounts: StorageAccount[]

The storage accounts for this resource.

Optional tags

tags: undefined | object

Resource tags.

serializedName

serializedName: string = "SubscriptionMediaService"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SubscriptionMediaService"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mediaServiceId

mediaServiceId: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.mediaServiceId"

type

type: object

name

name: "Uuid" = "Uuid"

storageAccounts

storageAccounts: object

serializedName

serializedName: string = "properties.storageAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StorageAccount"

name

name: "Composite" = "Composite"

Const SubscriptionMediaServiceCollection

SubscriptionMediaServiceCollection: object
interface

A collection of SubscriptionMediaService items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "SubscriptionMediaServiceCollection"

__@iterator

  • Iterator

    Returns IterableIterator<SubscriptionMediaService>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns SubscriptionMediaService[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SubscriptionMediaService[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SubscriptionMediaService]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SubscriptionMediaService

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SubscriptionMediaService[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SubscriptionMediaService[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SubscriptionMediaService | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns SubscriptionMediaService | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SubscriptionMediaService

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SubscriptionMediaService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SubscriptionMediaService

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SubscriptionMediaService | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns SubscriptionMediaService[]

shift

  • Removes the first element from an array and returns it.

    Returns SubscriptionMediaService | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SubscriptionMediaService[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SubscriptionMediaService[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SubscriptionMediaService[]

      Elements to insert into the array in place of the deleted elements.

    Returns SubscriptionMediaService[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SubscriptionMediaService>

type

type: object

className

className: string = "SubscriptionMediaServiceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubscriptionMediaService"

name

name: "Composite" = "Composite"

Const SyncStorageKeysInput

SyncStorageKeysInput: object

The input to the sync storage keys request.

Optional id

id: undefined | string

The ID of the storage account resource.

serializedName

serializedName: string = "SyncStorageKeysInput"

type

type: object

className

className: string = "SyncStorageKeysInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const TrackPropertyCondition

TrackPropertyCondition: object

Class to specify one track property condition

operation

Track property condition operation. Possible values include: 'Unknown', 'Equal'

property

Track property type. Possible values include: 'Unknown', 'FourCC'

Optional value

value: undefined | string

Track property value

serializedName

serializedName: string = "TrackPropertyCondition"

type

type: object

className

className: string = "TrackPropertyCondition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

required

required: true = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

property

property: object

required

required: true = true

serializedName

serializedName: string = "property"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const TrackSelection

TrackSelection: object

Class to select a track

Optional trackSelections

trackSelections: TrackPropertyCondition[]

TrackSelections is a track property condition list which can specify track(s)

serializedName

serializedName: string = "TrackSelection"

type

type: object

className

className: string = "TrackSelection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

trackSelections

trackSelections: object

serializedName

serializedName: string = "trackSelections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackPropertyCondition"

name

name: "Composite" = "Composite"

Const TrackedResource

TrackedResource: object

The resource model definition for a ARM tracked resource.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The Azure Region of the resource.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

serializedName

serializedName: string = "TrackedResource"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "TrackedResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const Transform

Transform: object

A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs.

Optional created

created: Date

The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

An optional verbose description of the Transform.

Optional id

id: undefined | string

Fully qualified resource ID for the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date

The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

outputs

outputs: TransformOutput[]

An array of one or more TransformOutputs that the Transform should generate.

serializedName

serializedName: string = "Transform"

Optional type

type: object

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Transform"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

created

created: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

nullable

nullable: false = false

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

outputs

outputs: object

required

required: true = true

serializedName

serializedName: string = "properties.outputs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TransformOutput"

name

name: "Composite" = "Composite"

Const TransformCollection

TransformCollection: object
interface

A collection of Transform items.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

A link to the next page of the collection (when the collection contains too many results to return in one response).

serializedName

serializedName: string = "TransformCollection"

__@iterator

  • Iterator

    Returns IterableIterator<Transform>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Transform>[]

      Additional items to add to the end of array1.

    Returns Transform[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Transform[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Transform]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Transform]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Transform, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Transform

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Transform[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Transform[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Transform | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Transform | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Transform, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Transform

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Transform, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Transform

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Transform, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Transform

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Transform | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Transform[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Transform
  • reduce(callbackfn: function, initialValue: Transform): Transform
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Transform

  • Parameters

    Returns Transform

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Transform, currentIndex: number, array: Transform[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Transform
  • reduceRight(callbackfn: function, initialValue: Transform): Transform
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Transform

  • Parameters

    Returns Transform

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Transform, currentIndex: number, array: Transform[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Transform[]

shift

  • Removes the first element from an array and returns it.

    Returns Transform | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Transform[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Transform[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Transform[]
  • splice(start: number, deleteCount: number, ...items: Transform[]): Transform[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Transform[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Transform[]

      Elements to insert into the array in place of the deleted elements.

    Returns Transform[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Transform[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Transform>

type

type: object

className

className: string = "TransformCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Transform"

name

name: "Composite" = "Composite"

Const TransformOutput

TransformOutput: object

Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output.

Optional onError

onError: OnErrorType

A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. Possible values include: 'StopProcessingJob', 'ContinueJob'

preset

preset: PresetUnion

Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output.

Optional relativePriority

relativePriority: Priority

Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. Possible values include: 'Low', 'Normal', 'High'

serializedName

serializedName: string = "TransformOutput"

type

type: object

className

className: string = "TransformOutput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

onError

onError: object

serializedName

serializedName: string = "onError"

type

type: object

name

name: "String" = "String"

preset

preset: object

required

required: true = true

serializedName

serializedName: string = "preset"

type

type: object

className

className: string = "Preset"

name

name: "Composite" = "Composite"

relativePriority

relativePriority: object

serializedName

serializedName: string = "relativePriority"

type

type: object

name

name: "String" = "String"

Const TransportStreamFormat

TransportStreamFormat: object

Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s).

filenamePattern

filenamePattern: string

The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.

odatatype

odatatype: "#Microsoft.Media.TransportStreamFormat"

Polymorphic Discriminator

Optional outputFiles

outputFiles: OutputFile[]

The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together .

serializedName

serializedName: string = "#Microsoft.Media.TransportStreamFormat"

type

type: object

className

className: string = "TransportStreamFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Format.type.polymorphicDiscriminator

uberParent

uberParent: string = "Format"

modelProperties

modelProperties: object

Const Video

Video: object

Describes the basic properties for encoding the input video.

Optional keyFrameInterval

keyFrameInterval: undefined | string

The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).

Optional label

label: undefined | string

An optional label for the codec. The label can be used to control muxing behavior.

odatatype

odatatype: "#Microsoft.Media.Video"

Polymorphic Discriminator

Optional stretchMode

stretchMode: StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit'

serializedName

serializedName: string = "#Microsoft.Media.Video"

type

type: object

className

className: string = "Video"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Codec.type.polymorphicDiscriminator

uberParent

uberParent: string = "Codec"

modelProperties

modelProperties: object

keyFrameInterval

keyFrameInterval: object

serializedName

serializedName: string = "keyFrameInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

stretchMode

stretchMode: object

serializedName

serializedName: string = "stretchMode"

type

type: object

name

name: "String" = "String"

Const VideoAnalyzerPreset

VideoAnalyzerPreset: object

A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.

Optional audioLanguage

audioLanguage: undefined | string

The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are English ('en-US' and 'en-GB'), Spanish ('es-ES' and 'es-MX'), French ('fr-FR'), Italian ('it-IT'), Japanese ('ja-JP'), Portuguese ('pt-BR'), Chinese ('zh-CN'), German ('de-DE'), Arabic ('ar-EG' and 'ar-SY'), Russian ('ru-RU'), Hindi ('hi-IN'), and Korean ('ko-KR'). If you know the language of your content, it is recommended that you specify it. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. This language detection feature currently supports English, Chinese, French, German, Italian, Japanese, Spanish, Russian, and Portuguese. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'."

Optional insightsToExtract

insightsToExtract: InsightsType

The type of insights to be extracted. If not set then based on the content the type will selected. If the content is audio only then only audio insights are extracted and if it is video only. Possible values include: 'AudioInsightsOnly', 'VideoInsightsOnly', 'AllInsights'

odatatype

odatatype: "#Microsoft.Media.VideoAnalyzerPreset"

Polymorphic Discriminator

serializedName

serializedName: string = "#Microsoft.Media.VideoAnalyzerPreset"

type

type: object

className

className: string = "VideoAnalyzerPreset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Preset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Preset"

modelProperties

modelProperties: object

insightsToExtract

insightsToExtract: object

serializedName

serializedName: string = "insightsToExtract"

type

type: object

name

name: "String" = "String"

Const VideoLayer

VideoLayer: object

Describes the settings to be used when encoding the input video into a desired output bitrate layer.

Optional adaptiveBFrame

adaptiveBFrame: undefined | false | true

Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.

Optional bFrames

bFrames: undefined | number

The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.

bitrate

bitrate: number

The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.

Optional frameRate

frameRate: undefined | string

The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.

Optional height

height: undefined | string

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

Optional label

label: undefined | string

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

Optional maxBitrate

maxBitrate: undefined | number

The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.

odatatype

odatatype: "#Microsoft.Media.VideoLayer"

Polymorphic Discriminator

Optional slices

slices: undefined | number

The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.

Optional width

width: undefined | string

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

serializedName

serializedName: string = "#Microsoft.Media.VideoLayer"

type

type: object

className

className: string = "VideoLayer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Layer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Layer"

modelProperties

modelProperties: object

adaptiveBFrame

adaptiveBFrame: object

serializedName

serializedName: string = "adaptiveBFrame"

type

type: object

name

name: "Boolean" = "Boolean"

bFrames

bFrames: object

serializedName

serializedName: string = "bFrames"

type

type: object

name

name: "Number" = "Number"

bitrate

bitrate: object

required

required: true = true

serializedName

serializedName: string = "bitrate"

type

type: object

name

name: "Number" = "Number"

frameRate

frameRate: object

serializedName

serializedName: string = "frameRate"

type

type: object

name

name: "String" = "String"

maxBitrate

maxBitrate: object

serializedName

serializedName: string = "maxBitrate"

type

type: object

name

name: "Number" = "Number"

slices

slices: object

serializedName

serializedName: string = "slices"

type

type: object

name

name: "Number" = "Number"

Const VideoOverlay

VideoOverlay: object

Describes the properties of a video overlay.

Optional audioGainLevel

audioGainLevel: undefined | number

The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.

Optional cropRectangle

cropRectangle: Rectangle

An optional rectangular window used to crop the overlay image or video.

Optional end

end: undefined | string

The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media.

Optional fadeInDuration

fadeInDuration: undefined | string

The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).

Optional fadeOutDuration

fadeOutDuration: undefined | string

The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).

inputLabel

inputLabel: string

The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats.

odatatype

odatatype: "#Microsoft.Media.VideoOverlay"

Polymorphic Discriminator

Optional opacity

opacity: undefined | number

The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque.

Optional position

position: Rectangle

The location in the input video where the overlay is applied.

Optional start

start: undefined | string

The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video.

serializedName

serializedName: string = "#Microsoft.Media.VideoOverlay"

type

type: object

className

className: string = "VideoOverlay"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Overlay.type.polymorphicDiscriminator

uberParent

uberParent: string = "Overlay"

modelProperties

modelProperties: object

cropRectangle

cropRectangle: object

serializedName

serializedName: string = "cropRectangle"

type

type: object

className

className: string = "Rectangle"

name

name: "Composite" = "Composite"

opacity

opacity: object

serializedName

serializedName: string = "opacity"

type

type: object

name

name: "Number" = "Number"

position

position: object

serializedName

serializedName: string = "position"

type

type: object

className

className: string = "Rectangle"

name

name: "Composite" = "Composite"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const accountName

accountName: object

parameterPath

parameterPath: string = "accountName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const assetName

assetName: object

parameterPath

parameterPath: string = "assetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "assetName"

type

type: object

name

name: "String" = "String"

Const autoStart

autoStart: object

parameterPath

parameterPath: string[] = ["options","autoStart"]

mapper

mapper: object

serializedName

serializedName: string = "autoStart"

type

type: object

name

name: "Boolean" = "Boolean"

Const contentKeyPolicyName

contentKeyPolicyName: object

parameterPath

parameterPath: string = "contentKeyPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "contentKeyPolicyName"

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

Codec

Codec: CompositeMapper = Codec

Codec.#Microsoft.Media.AacAudio

Codec.#Microsoft.Media.AacAudio: CompositeMapper = AacAudio

Codec.#Microsoft.Media.Audio

Codec.#Microsoft.Media.Audio: CompositeMapper = Audio

Codec.#Microsoft.Media.CopyAudio

Codec.#Microsoft.Media.CopyAudio: CompositeMapper = CopyAudio

Codec.#Microsoft.Media.CopyVideo

Codec.#Microsoft.Media.CopyVideo: CompositeMapper = CopyVideo

Codec.#Microsoft.Media.H264Video

Codec.#Microsoft.Media.H264Video: CompositeMapper = H264Video

Codec.#Microsoft.Media.Image

Codec.#Microsoft.Media.Image: CompositeMapper = Image

Codec.#Microsoft.Media.JpgImage

Codec.#Microsoft.Media.JpgImage: CompositeMapper = JpgImage

Codec.#Microsoft.Media.PngImage

Codec.#Microsoft.Media.PngImage: CompositeMapper = PngImage

Codec.#Microsoft.Media.Video

Codec.#Microsoft.Media.Video: CompositeMapper = Video

ContentKeyPolicyConfiguration

ContentKeyPolicyConfiguration: CompositeMapper = ContentKeyPolicyConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration: CompositeMapper = ContentKeyPolicyClearKeyConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration: CompositeMapper = ContentKeyPolicyFairPlayConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration: CompositeMapper = ContentKeyPolicyPlayReadyConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyUnknownConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyUnknownConfiguration: CompositeMapper = ContentKeyPolicyUnknownConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyWidevineConfiguration

ContentKeyPolicyConfiguration.#Microsoft.Media.ContentKeyPolicyWidevineConfiguration: CompositeMapper = ContentKeyPolicyWidevineConfiguration

ContentKeyPolicyPlayReadyContentKeyLocation

ContentKeyPolicyPlayReadyContentKeyLocation: CompositeMapper = ContentKeyPolicyPlayReadyContentKeyLocation

ContentKeyPolicyPlayReadyContentKeyLocation.#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

ContentKeyPolicyPlayReadyContentKeyLocation.#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader: CompositeMapper = ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

ContentKeyPolicyPlayReadyContentKeyLocation.#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

ContentKeyPolicyPlayReadyContentKeyLocation.#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier: CompositeMapper = ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

ContentKeyPolicyRestriction

ContentKeyPolicyRestriction: CompositeMapper = ContentKeyPolicyRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyOpenRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyOpenRestriction: CompositeMapper = ContentKeyPolicyOpenRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyTokenRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyTokenRestriction: CompositeMapper = ContentKeyPolicyTokenRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyUnknownRestriction

ContentKeyPolicyRestriction.#Microsoft.Media.ContentKeyPolicyUnknownRestriction: CompositeMapper = ContentKeyPolicyUnknownRestriction

ContentKeyPolicyRestrictionTokenKey

ContentKeyPolicyRestrictionTokenKey: CompositeMapper = ContentKeyPolicyRestrictionTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicyRsaTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicyRsaTokenKey: CompositeMapper = ContentKeyPolicyRsaTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicySymmetricTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicySymmetricTokenKey: CompositeMapper = ContentKeyPolicySymmetricTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey

ContentKeyPolicyRestrictionTokenKey.#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey: CompositeMapper = ContentKeyPolicyX509CertificateTokenKey

Format

Format: CompositeMapper = Format

Format.#Microsoft.Media.ImageFormat

Format.#Microsoft.Media.ImageFormat: CompositeMapper = ImageFormat

Format.#Microsoft.Media.JpgFormat

Format.#Microsoft.Media.JpgFormat: CompositeMapper = JpgFormat

Format.#Microsoft.Media.Mp4Format

Format.#Microsoft.Media.Mp4Format: CompositeMapper = Mp4Format

Format.#Microsoft.Media.MultiBitrateFormat

Format.#Microsoft.Media.MultiBitrateFormat: CompositeMapper = MultiBitrateFormat

Format.#Microsoft.Media.PngFormat

Format.#Microsoft.Media.PngFormat: CompositeMapper = PngFormat

Format.#Microsoft.Media.TransportStreamFormat

Format.#Microsoft.Media.TransportStreamFormat: CompositeMapper = TransportStreamFormat

JobInput

JobInput: CompositeMapper = JobInput

JobInput.#Microsoft.Media.JobInputAsset

JobInput.#Microsoft.Media.JobInputAsset: CompositeMapper = JobInputAsset

JobInput.#Microsoft.Media.JobInputClip

JobInput.#Microsoft.Media.JobInputClip: CompositeMapper = JobInputClip

JobInput.#Microsoft.Media.JobInputHttp

JobInput.#Microsoft.Media.JobInputHttp: CompositeMapper = JobInputHttp

JobInput.#Microsoft.Media.JobInputs

JobInput.#Microsoft.Media.JobInputs: CompositeMapper = JobInputs

JobOutput

JobOutput: CompositeMapper = JobOutput

JobOutput.#Microsoft.Media.JobOutputAsset

JobOutput.#Microsoft.Media.JobOutputAsset: CompositeMapper = JobOutputAsset

Layer

Layer: CompositeMapper = Layer

Layer.#Microsoft.Media.H264Layer

Layer.#Microsoft.Media.H264Layer: CompositeMapper = H264Layer

Layer.#Microsoft.Media.JpgLayer

Layer.#Microsoft.Media.JpgLayer: CompositeMapper = JpgLayer

Layer.#Microsoft.Media.PngLayer

Layer.#Microsoft.Media.PngLayer: CompositeMapper = PngLayer

Layer.#Microsoft.Media.VideoLayer

Layer.#Microsoft.Media.VideoLayer: CompositeMapper = VideoLayer

Overlay

Overlay: CompositeMapper = Overlay

Overlay.#Microsoft.Media.AudioOverlay

Overlay.#Microsoft.Media.AudioOverlay: CompositeMapper = AudioOverlay

Overlay.#Microsoft.Media.VideoOverlay

Overlay.#Microsoft.Media.VideoOverlay: CompositeMapper = VideoOverlay

Preset

Preset: CompositeMapper = Preset

Preset.#Microsoft.Media.AudioAnalyzerPreset

Preset.#Microsoft.Media.AudioAnalyzerPreset: CompositeMapper = AudioAnalyzerPreset

Preset.#Microsoft.Media.BuiltInStandardEncoderPreset

Preset.#Microsoft.Media.BuiltInStandardEncoderPreset: CompositeMapper = BuiltInStandardEncoderPreset

Preset.#Microsoft.Media.FaceDetectorPreset

Preset.#Microsoft.Media.FaceDetectorPreset: CompositeMapper = FaceDetectorPreset

Preset.#Microsoft.Media.StandardEncoderPreset

Preset.#Microsoft.Media.StandardEncoderPreset: CompositeMapper = StandardEncoderPreset

Preset.#Microsoft.Media.VideoAnalyzerPreset

Preset.#Microsoft.Media.VideoAnalyzerPreset: CompositeMapper = VideoAnalyzerPreset

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filterName

filterName: object

parameterPath

parameterPath: string = "filterName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "filterName"

type

type: object

name

name: "String" = "String"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const liveEventName

liveEventName: object

parameterPath

parameterPath: string = "liveEventName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "liveEventName"

constraints

constraints: object

MaxLength

MaxLength: number = 32

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$/

type

type: object

name

name: "String" = "String"

Const liveOutputName

liveOutputName: object

parameterPath

parameterPath: string = "liveOutputName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "liveOutputName"

constraints

constraints: object

MaxLength

MaxLength: number = 256

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$/

type

type: object

name

name: "String" = "String"

Const locationName

locationName: object

parameterPath

parameterPath: string = "locationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const orderby

orderby: object

parameterPath

parameterPath: string[] = ["options","orderby"]

mapper

mapper: object

serializedName

serializedName: string = "$orderby"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const streamingEndpointName

streamingEndpointName: object

parameterPath

parameterPath: string = "streamingEndpointName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "streamingEndpointName"

constraints

constraints: object

MaxLength

MaxLength: number = 24

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$/

type

type: object

name

name: "String" = "String"

Const streamingLocatorName

streamingLocatorName: object

parameterPath

parameterPath: string = "streamingLocatorName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "streamingLocatorName"

type

type: object

name

name: "String" = "String"

Const streamingPolicyName

streamingPolicyName: object

parameterPath

parameterPath: string = "streamingPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "streamingPolicyName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "Number" = "Number"

Const transformName

transformName: object

parameterPath

parameterPath: string = "transformName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "transformName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc